From fa12452bbdb02cb4bc1103c56bb94e416a6787aa Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Fri, 2 Mar 2018 09:27:23 +0800
Subject: [PATCH] Follow the new PTI for document build

For compliance with the Project Testing Interface as described in:

https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:

http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I10537cf02d83f127b6932fa3f427043fb267d8b1
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
---
 doc/requirements.txt  | 7 +++++++
 setup.cfg             | 6 ------
 test-requirements.txt | 5 -----
 tox.ini               | 6 ++++--
 4 files changed, 11 insertions(+), 13 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 00000000..244b6b6c
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,7 @@
+# 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/setup.cfg b/setup.cfg
index 85e6a830..f489b25d 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -34,12 +34,6 @@ oslo.config.opts =
 console_scripts =
     convert-json = oslo_log.cmds.convert_json:main
 
-[build_sphinx]
-all-files = 1
-warning-is-error = 1
-source-dir = doc/source
-build-dir = doc/build
-
 [upload_sphinx]
 upload-dir = doc/build/html
 
diff --git a/test-requirements.txt b/test-requirements.txt
index 3aead8d5..ad8d09a1 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -14,10 +14,5 @@ oslotest>=3.3.0 # Apache-2.0
 #  deps = {[testenv]deps} coverage
 coverage>=4.5.1 # Apache-2.0
 
-# this is required for the docs build jobs
-sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
-openstackdocstheme>=1.20.0 # Apache-2.0
-reno>=2.7.0 # Apache-2.0
-
 # Bandit security code scanner
 bandit>=1.1.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index c8f2e371..58e3b68f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -30,11 +30,13 @@ commands = {posargs}
 
 [testenv:docs]
 basepython = python3
-commands = python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -a -E -W -b html doc/source doc/build/html
 
 [testenv:releasenotes]
 basepython = python3
-commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -a -E -W -b html releasenotes/source releasenotes/build/html
 
 [testenv:cover]
 basepython = python3