Merge "Use the autodoc Sphinx extension"

doc/source/conf.py

@@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 # 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',
     'sphinxcontrib.programoutput',
     'oslosphinx'
 ]

doc/source/contributing.rst

@@ -2,3 +2,36 @@
 Contributing
 ============
 .. include:: ../../CONTRIBUTING.rst
+
+
+Python API
+----------
+
+No internal API stability guarantees are made, but for reference
+here is a basic outline of the source implementation:
+
+.. automodule:: bindep
+   :members:
+
+.. automodule:: bindep.depends
+   :members:
+
+.. automodule:: bindep.main
+   :members:
+
+
+Internal Unit Tests
+-------------------
+
+The bindep utility is developed following a test-driven methodology.
+These are the current tests run to ensure its internal consistency
+for every commit:
+
+.. automodule:: bindep.tests
+   :members:
+
+.. automodule:: bindep.tests.test_depends
+   :members:
+
+.. automodule:: bindep.tests.test_main
+   :members:

doc/source/index.rst

@@ -19,4 +19,5 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`