Add API documentation

Author: olgabot

docs/conf.py

@@ -38,13 +38,20 @@
 # 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', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode',
+              'sphinx.ext.autosummary',
+              'numpydoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+autosummary_generate = True
+numpydoc_show_class_members = False
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 

docs/index.rst

@@ -18,6 +18,13 @@ Contents:
    authors
    history
 
+.. autosummary::
+    :toctree: generated/
+
+    gitgoing.mean_plus_one
+    gitgoing.std_plus_one
+    gitgoing.cv
+
 Indices and tables
 ==================
 

docs/requirements.txt

@@ -1,4 +1,5 @@
 Sphinx
 fabric
 sphinx_bootstrap_theme
-pandoc
+pandoc
+numpydoc