From 085ad0a6cfabe6f65cae80a9622a7d6c58e2d99b Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Sat, 2 Jun 2018 11:27:42 +0900
Subject: [PATCH] Follow the new PTI for document build

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

This also re-organizes index.rst

Change-Id: Ic2509e76d03c159cf40e84f6b5912fdabe826c8d
---
 doc/requirements.txt  |  6 ++++++
 doc/source/index.rst  | 10 +++++-----
 setup.cfg             |  9 ---------
 test-requirements.txt |  3 ---
 tox.ini               |  4 +++-
 5 files changed, 14 insertions(+), 18 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 000000000..012efb226
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,6 @@
+# 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
+openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 6ebb79b1d..cb0bc24a6 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,8 +6,8 @@
 Welcome to kuryr-kubernetes's documentation!
 ============================================
 
-Contents:
-
+Contents
+--------
 .. toctree::
    :maxdepth: 3
 
@@ -17,7 +17,7 @@ Contents:
    contributing
 
 Developer Docs
-==============
+--------------
 
 .. toctree::
    :maxdepth: 3
@@ -25,7 +25,7 @@ Developer Docs
    devref/index
 
 Design Specs
-============
+------------
 
 .. toctree::
    :maxdepth: 1
@@ -36,7 +36,7 @@ Design Specs
    specs/queens/network_policy
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`search`
diff --git a/setup.cfg b/setup.cfg
index 57bbb365e..5c284d7ab 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -87,15 +87,6 @@ kuryr_kubernetes.controller.handlers =
 packages =
     kuryr_kubernetes
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-warning-is-error = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
 [compile_catalog]
 directory = kuryr-kubernetes/locale
 domain = kuryr-kubernetes
diff --git a/test-requirements.txt b/test-requirements.txt
index 664ca857c..5f97901c1 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -9,11 +9,8 @@ ddt>=1.0.1 # MIT
 docutils>=0.11 # OSI-Approved Open Source, Public Domain
 mock>=2.0.0 # BSD
 python-subunit>=1.0.0 # Apache-2.0/BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 os-testr>=1.0.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
-reno>=2.5.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 98bc6bda3..948f83782 100644
--- a/tox.ini
+++ b/tox.ini
@@ -46,7 +46,8 @@ commands =
   coverage report
 
 [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
 
 [flake8]
 show-source = true
@@ -70,6 +71,7 @@ local-check-factory = neutron_lib.hacking.checks.factory
 commands = oslo-config-generator --config-file=etc/oslo-config-generator/kuryr.conf
 
 [testenv:releasenotes]
+deps = -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:lower-constraints]