auto-generate API documentation

Tell pbr to automatically generate the API documentation and remove the
hand-curated file doing the same. Move the new API documentation section
to a separate toctree to allow us to only show one level of nodes in the
table of contents.

Change-Id: I8edd36090688a607685d5708f99a78fd235defed

.gitignore

@@ -41,6 +41,7 @@ output/*/index.html
 
 # Sphinx
 doc/build
+/doc/source/api/
 
 # pbr generates these
 AUTHORS
@@ -48,4 +49,4 @@ ChangeLog
 
 # Editors
 *~
-.*.swp
+.*.swp

doc/source/api.rst

@@ -1,51 +0,0 @@
-=====
- API
-=====
-
-oslotest.base
-=============
-
-.. automodule:: oslotest.base
-
-.. autoclass:: oslotest.base.BaseTestCase
-   :members:
-
-oslotest.createfile
-===================
-
-.. automodule:: oslotest.createfile
-   :members:
-   :special-members:
-
-oslotest.log
-============
-
-.. automodule:: oslotest.log
-   :members:
-   :special-members:
-
-oslotest.mockpatch
-==================
-
-.. automodule:: oslotest.mockpatch
-   :members:
-   :special-members:
-
-oslotest.moxstubout
-===================
-
-.. automodule:: oslotest.moxstubout
-   :members:
-
-oslotest.output
-===================
-
-.. automodule:: oslotest.output
-   :members:
-
-oslotest.timeout
-================
-
-.. automodule:: oslotest.timeout
-   :members:
-   :special-members:

doc/source/conf.py

@@ -29,6 +29,7 @@ extensions = [
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
+modindex_common_prefix = ['oslotest.']
 
 # The suffix of source filenames.
 source_suffix = '.rst'

doc/source/index.rst

@@ -10,7 +10,6 @@ Contents
    :maxdepth: 2
 
    installation
-   api
    testing
    features
    cross-testing
@@ -18,6 +17,14 @@ Contents
    contributing
    history
 
+API
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex
+
 Indices and tables
 ==================
 

setup.cfg

@@ -37,6 +37,7 @@ upload-dir = doc/build/html
 
 [pbr]
 warnerrors = true
+autodoc_index_modules = true
 
 [wheel]
 universal = true