add docs

Makefile

@@ -0,0 +1,19 @@
+.PHONY: test clean
+
+test:
+	python setup.py test
+
+clean:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	make -C ./docs clean
+
+docs:
+	make -C ./docs html
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  test    to run tests"
+	@echo "  clean   to clean temporary files"
+	@echo "  docs    to generate documentation"

docs/.gitignore

@@ -0,0 +1,2 @@
+api
+_build

docs/Makefile

@@ -0,0 +1,32 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = gdbgui
+SOURCEDIR     = .
+BUILDDIR      = _build
+EXCLUDE_FROM_APIDOCS = tests *printcolor* *setup.py*
+
+# # Put it first so that "make" without argument is like "make help".
+# help:
+# 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile gen_apidoc html clean
+
+html: clean gen_apidoc
+	$(SPHINXBUILD) -b html . $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+gen_apidoc:
+	rm -rf api
+	cd ..; sphinx-apidoc -o docs/api . $(EXCLUDE_FROM_APIDOCS)
+
+clean:
+	rm -rf _build
+	rm -rf api
+
+publish: html
+	rsync --delete -pthrvz -c --rsh='ssh -p 22' _build/html/ [email protected]:/var/www/grassfedcode.com/gdbgui

docs/conf.py

@@ -0,0 +1,165 @@
+# -*- coding: utf-8 -*-
+#
+# gdbgui documentation build configuration file, created by
+# sphinx-quickstart on Sun Feb  5 07:59:05 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+# Insert 'gdbgui' path into the system.
+sys.path.insert(0, os.path.abspath('../'))
+
+from gdbgui import __version__
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'gdbgui'
+copyright = u'2017, Chad Smith'
+author = u'Chad Smith'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = __version__
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+
+html_theme_options = {
+    'show_powered_by': False,
+    'github_user': 'cs01',
+    'github_repo': 'gdbgui',
+    'github_banner': True,
+    'show_related': False
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'gdbguidoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'gdbgui.tex', u'gdbgui Documentation',
+     u'Chad Smith', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'gdbgui', u'gdbgui Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'gdbgui', u'gdbgui Documentation',
+     author, 'gdbgui', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,144 @@
+.. gdbgui documentation master file, created by
+   sphinx-quickstart on Sun Feb  5 07:59:05 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+gdbgui - A browser-based frontend/gui for GDB
+============================================================
+
+Release v\ |version|
+
+.. image:: https://travis-ci.org/cs01/gdbgui.svg?branch=master
+  :target: https://travis-ci.org/cs01/gdbgui
+
+.. image:: https://img.shields.io/badge/pypi-v0.7.3.3-blue.svg
+  :target: https://pypi.python.org/pypi/gdbgui/
+
+.. image:: https://img.shields.io/badge/python-2.7, 3.3, 3.4, 3.5, pypy-blue.svg
+  :target: https://pypi.python.org/pypi/gdbgui/
+
+.. image:: https://img.shields.io/badge/SayThanks.io-☼-blue.svg
+  :target: https://saythanks.io/to/grassfedcode
+
+.. image:: https://img.shields.io/gratipay/cs01.svg
+  :target: https://gratipay.com/cs01/
+
+
+Mission
+------------
+1. Make using gdb easier than adding ``printf``'s.
+2. Make gdbgui as beautiful as a modern web application should be.
+
+Quickstart
+----------
+::
+
+    pip install gdbgui
+    gdbgui
+
+Features
+----------
+- Display source code and assembly inline
+- Step through source code and assembly
+- Visually add and remove breakpoints
+- Searchable list of symbols used to create binary
+- View and switch frames in stack, and active thread
+- Display variables
+- Evaluate expressions
+- Explore memory
+- View all register values
+- Full feature gdb console
+
+Screenshots
+-----------
+
+Screencast
+-----------
+A quick capture of gdbgui in use.
+
+.. image:: _static/images/screencast.gif
+  :target: _static/images/screencast.gif
+
+Enter the binary and args just as you'd call them on the command line. Binary is restored when gdbgui is opened at a later time.
+
+.. image:: _static/images/load_binary_and_args.png
+  :target: _static/images/load_binary_and_args.png
+
+Intuitive control of your program. From left to right: Run, Continue, Next, Step, Return, Next Instruction, Step Instruction, send interrupt signal (SIGINT) to inferior process.
+
+.. image:: _static/images/controls.png
+  :target: _static/images/controls.png
+
+Stack/Threads
+-----------
+View all threads, the full stack on the active thread, the current frame on inactive threads. Switch between frames on the stack, or threads by pointing and clicking.
+
+.. image:: _static/images/stack_and_threads.png
+  :target: _static/images/stack_and_threads.png
+
+Source Code
+-----------
+View source, assembly, add breakpoints. All symbols used to compile the target are listed in a dropdown above the source code viewer, and have autocompletion capabilities.
+
+.. image:: _static/images/source.png
+  :target: _static/images/source.png
+
+.. image:: _static/images/source_with_assembly.png
+  :target: _static/images/source_with_assembly.png
+
+
+Variables and Expressions
+-----------
+
+.. image:: _static/images/locals.png
+  :target: _static/images/locals.png
+
+All variables and their values are displayed each time gdb pauses. Arbitrary expressions can be evaluated as well.
+
+.. image:: _static/images/expressions.png
+  :target: _static/images/expressions.png
+
+
+Memory Viewer
+-----------
+All hex addresses are automatically converted to clickable links to explore memory. Length of memory is configurable. In this case 16 bytes are displayed per row.
+
+.. image:: _static/images/memory.png
+  :target: _static/images/memory.png
+
+
+Registers
+-----------
+View all registers. If a register was updated it is highlighted in yellow.
+
+.. image:: _static/images/registers.png
+  :target: _static/images/registers.png
+
+
+gdb console
+-----------
+Read gdb output, and write to the gdb subprocess as desired. Don't let any gdb commandline skills you've developed go to waste.
+
+.. image:: _static/images/console.png
+  :target: _static/images/console.png
+
+
+gdbgui at launch:
+
+.. image:: _static/images/ready.png
+  :target: _static/images/ready.png
+
+.. raw:: html
+
+    <embed>
+      <script>
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+        ga('create', 'UA-90243909-1', 'auto');
+        ga('send', 'pageview');
+
+      </script>
+    </embed>