diff --git a/.gitignore b/.gitignore index ab1b72743..77f6e2101 100644 --- a/.gitignore +++ b/.gitignore @@ -26,7 +26,9 @@ subunit.log *.sw? *~ .eggs/ +.stestr/ +SP1_res.yaml releasenotes/build etc/tacker/tacker.conf.sample -doc/source/api +doc/source/contributor/api diff --git a/doc/requirements.txt b/doc/requirements.txt index f6d80e51c..e46dbddb8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,6 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD openstackdocstheme>=1.18.1 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 73a7d8b9f..c500d7fc0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,15 +20,25 @@ 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', - #'sphinx.ext.intersphinx', + 'sphinxcontrib.apidoc', 'stevedore.sphinxext', 'openstackdocstheme', ] -# 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 +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../tacker' +apidoc_output_dir = 'contributor/api' +apidoc_excluded_paths = [ + 'tests/*', + 'tests', + 'nfvo/workflows/*', + 'nfvo/workflows', + 'vnfm/workflows/*', + 'vnfm/workflows', + 'db/migration/alembic_migrations/*', + 'db/migration/alembic_migrations', + 'hacking'] +apidoc_separate_modules = True # The suffix of source filenames. source_suffix = '.rst' diff --git a/doc/source/contributor/api/api_extensions.rst b/doc/source/contributor/api_extensions.rst similarity index 100% rename from doc/source/contributor/api/api_extensions.rst rename to doc/source/contributor/api_extensions.rst diff --git a/doc/source/contributor/api/api_layer.rst b/doc/source/contributor/api_layer.rst similarity index 100% rename from doc/source/contributor/api/api_layer.rst rename to doc/source/contributor/api_layer.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index af4ffe4c8..3cf6129b7 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -26,11 +26,17 @@ Developer Info dev-process.rst development.environment.rst - api/api_layer.rst - api/api_extensions.rst + api_layer.rst + api_extensions.rst tacker_functional_test.rst dashboards.rst +Code Documentation +------------------ + +:ref:`modindex` + + API Documentation ----------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 6b3213935..f4e4cb44e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -60,5 +60,6 @@ Project Info Indices and tables ------------------ -* :ref:`search` +* :ref:`genindex` * :ref:`modindex` +* :ref:`search`