diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2015-09-24 18:55:40 +0000 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2015-09-25 14:07:46 +0000 |
| commit | e265141db88777eeffc92d3d2d12613876210cd9 (patch) | |
| tree | 09a15ecc42fb953bdc79a58a91b0911de65988bd /doc | |
| parent | 4c164868c46102d26d645c4da3098237af7d382d (diff) | |
| download | oslotest-e265141db88777eeffc92d3d2d12613876210cd9.tar.gz | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api.rst | 51 | ||||
| -rwxr-xr-x | doc/source/conf.py | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 9 |
3 files changed, 9 insertions, 52 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst deleted file mode 100644 index fbd3965..0000000 --- a/doc/source/api.rst +++ /dev/null @@ -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: diff --git a/doc/source/conf.py b/doc/source/conf.py index bb2e39d..090e478 100755 --- a/doc/source/conf.py +++ b/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' diff --git a/doc/source/index.rst b/doc/source/index.rst index e0089ee..2e91752 100644 --- a/doc/source/index.rst +++ b/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 ================== |