Add module index for tacker docs

The module index for tacker docs is dropped due to new
PTI for building docs. However, sphinxcontrib.apidoc
now support to build autodoc which replace pbr autodoc.
We can have it again.

Closes-Bug: #1761923
Change-Id: Ie4c98dd6e8b365778cb0d2c377a9600d79cb43d1

.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

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

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',
+    'sphinxcontrib.apidoc',
-    #'sphinx.ext.intersphinx',
     'stevedore.sphinxext',
     'openstackdocstheme',
 ]
 
-# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# sphinxcontrib.apidoc options
-# text edit cycles.
+apidoc_module_dir = '../../tacker'
-# execute "export SPHINX_DEBUG=1" in your terminal to disable
+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'

doc/source/contributor/index.rst

@@ -26,11 +26,17 @@ Developer Info
 
    dev-process.rst
    development.environment.rst
-   api/api_layer.rst
+   api_layer.rst
-   api/api_extensions.rst
+   api_extensions.rst
    tacker_functional_test.rst
    dashboards.rst
 
+Code Documentation
+------------------
+
+:ref:`modindex`
+
+
 API Documentation
 -----------------
 

doc/source/index.rst

@@ -60,5 +60,6 @@ Project Info
 Indices and tables
 ------------------
 
-* :ref:`search`
+* :ref:`genindex`
 * :ref:`modindex`
+* :ref:`search`