Add autogenerated api docs.

.gitignore

@@ -44,3 +44,9 @@ other_modules/
 
 # Tox temporary files
 .tox/
+
+# Sphinx docs
+/docs/build
+# autogenerated by pbr
+/docs/source/api
+

CONTRIBUTING.md

@@ -334,3 +334,21 @@ npm run update_prebuilt
 
 That last step is easy to forget, so try to make it a habit whenever you're
 prepping a PR that includes frontend work.
+
+## Building documentation
+
+The documentation compiler loads each module to look for
+docstrings. That means you need dependencies installed, including
+optional ones:
+
+``` shellsession
+pip install -e .[usb_plugs]
+```
+
+You can then build the docs:
+
+``` shellsession
+python setup.py build_sphinx
+```
+
+The main index page will then be at `docs/build/html/index.html`.

docs/source/conf.py

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+#
+# OpenHTF documentation build configuration file, created by
+# sphinx-quickstart on Sun Aug 20 15:23:48 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
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+
+needs_sphinx = '1.3'                      # for napoleon
+
+# 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',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+]
+
+# 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'OpenHTF'
+copyright = u'2017, OpenHTF Contributors'
+author = u'OpenHTF Contributors'
+
+# 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 = u''
+# The full version, including alpha/beta/rc tags.
+release = u''
+
+# 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 = 'en'
+
+# 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 = []
+
+# 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenHTFdoc'
+
+
+# -- 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, 'OpenHTF.tex', u'OpenHTF Documentation',
+     u'OpenHTF Contributors', '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, 'openhtf', u'OpenHTF 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, 'OpenHTF', u'OpenHTF Documentation',
+     author, 'OpenHTF', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. OpenHTF documentation master file, created by
+   sphinx-quickstart on Sun Aug 20 15:23:48 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OpenHTF's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api/autoindex
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

setup.cfg

@@ -1,2 +1,10 @@
+[metadata]
+name = openhtf
+url = https://github.com/google/openhtf
+[pbr]
+autodoc_index_modules = true
+[build_sphinx]
+source_dir = docs/source
+build_dir = docs/build
 [wheel]
 universal = 1

setup.py

@@ -159,7 +159,7 @@ def run_tests(self):
 
 
 setup(
-    name='openhtf',
+    pbr=True,
     version='1.1.0',
     description='OpenHTF, the open hardware testing framework.',
     author='John Hawley',
@@ -186,6 +186,7 @@ def run_tests(self):
         ],
     },
     setup_requires=[
+        'pbr',
         'wheel>=0.29.0,<1.0',
     ],
     tests_require=[

tox.ini

@@ -9,3 +9,8 @@ commands = {envbindir}/python setup.py build_proto
 # Instead, it does 'python setup.py develop' which only adds openhtf/ to the
 # path.
 usedevelop = True
+
+[testenv:docs]
+deps=sphinx
+commands=
+    {envbindir}/setup.py build_sphinx