From 6c7e8d9a23465b89f01437b251eec19c29ac296a Mon Sep 17 00:00:00 2001 From: Attila Fazekas Date: Tue, 30 Jul 2013 15:59:49 +0200 Subject: [PATCH] Generate temepst API doc from source This change adds an rst file for every tempest module, with the 'automodule' macro. The root of the API documetation will be in the 'API and test cases' section on the main page. https://review.openstack.org/39427 Change-Id: I4065a24328dc85bb158b15bdfddb10ee0839916b --- doc/source/index.rst | 7 +++++++ setup.cfg | 3 +++ 2 files changed, 10 insertions(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index f012097708..00c4e9a2c0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,6 +33,13 @@ where your test contributions should go. field_guide/thirdparty field_guide/whitebox +------------------ +API and test cases +------------------ +.. toctree:: + :maxdepth: 1 + + api/modules ================== Indices and tables diff --git a/setup.cfg b/setup.cfg index 3b13b603dc..7cfc4ce013 100644 --- a/setup.cfg +++ b/setup.cfg @@ -35,3 +35,6 @@ source-dir = doc/source # coverage http://pypi.python.org/pypi/coverage # openstack-nose https://github.com/openstack-dev/openstack-nose verbosity=2 + +[pbr] +autodoc_tree_index_modules=true