Follow the new PTI for document build

- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
[3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Depends-On: https://review.openstack.org/#/c/559330/
Change-Id: I36051485854bdf88719335f280f5562c3a0dbd4a

doc/requirements.txt

@@ -0,0 +1,8 @@
+# The order of packages is significant, because pip processes them in the order
+# 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
+sphinxmark>=0.1.14 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=2.5.0 # Apache-2.0

doc/source/conf.py

@@ -41,7 +41,7 @@ sys.path.insert(0, ROOT_DIR)
 
 # 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',
+extensions = ['sphinxcontrib.apidoc',
               'sphinx.ext.coverage',
               'sphinx.ext.ifconfig',
               'sphinx.ext.graphviz',
@@ -52,6 +52,15 @@ extensions = ['sphinx.ext.autodoc',
 
 todo_include_todos = True
 
+# sphinxcontrib.apidoc options
+apidoc_module_dir = '../../neutron_fwaas'
+apidoc_output_dir = 'contributor/api'
+apidoc_excluded_paths = [
+    'setup.py',
+    'tests/*',
+    'tests']
+apidoc_separate_modules = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
 

setup.cfg

@@ -61,12 +61,6 @@ neutron_fwaas.services.firewall.drivers.linux =
     conntrack = neutron_fwaas.services.firewall.drivers.linux.legacy_conntrack:ConntrackLegacy
     netlink_conntrack = neutron_fwaas.services.firewall.drivers.linux.netlink_conntrack:ConntrackNetlink
 
-[build_sphinx]
-all_files = 1
-build-dir = doc/build
-source-dir = doc/source
-warning-is-error = 1
-
 [extract_messages]
 keywords = _ gettext ngettext l_ lazy_gettext
 mapping_file = babel.cfg
@@ -83,10 +77,3 @@ input_file = neutron_fwaas/locale/neutron_fwaas.pot
 
 [wheel]
 universal = 1
-
-[pbr]
-autodoc_tree_index_modules = True
-autodoc_tree_excludes =
-  setup.py
-  neutron_fwaas/tests
-api_doc_dir = contributor/api

test-requirements.txt

@@ -4,13 +4,10 @@
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
-fixtures>=3.0.0 # Apache-2.0/BSD
 flake8-import-order==0.12 # LGPLv3
 mock>=2.0.0 # BSD
 python-subunit>=1.0.0 # Apache-2.0/BSD
 requests-mock>=1.2.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-openstackdocstheme>=1.18.1 # Apache-2.0
 oslo.concurrency>=3.26.0 # Apache-2.0
 os-testr>=1.0.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
@@ -20,7 +17,6 @@ testscenarios>=0.4 # Apache-2.0/BSD
 WebOb>=1.7.1 # MIT
 WebTest>=2.0.27 # MIT
 oslotest>=3.2.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
 PyMySQL>=0.7.6 # MIT License
 psycopg2>=2.6.2 # LGPL/ZPL
 doc8>=0.6.0 # Apache-2.0

tox.ini

@@ -58,6 +58,7 @@ commands =
   python setup.py testr --slowest --testr-args='{posargs}'
 
 [testenv:releasenotes]
+deps = -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:pep8]
@@ -78,7 +79,8 @@ commands =
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -W -b html doc/source doc/build/html
 
 [doc8]
 ignore = D000