From e6991e19142ca337132bd7008a6a1ddc27d6951f Mon Sep 17 00:00:00 2001
From: Tin Lam <tin@irrational.io>
Date: Thu, 28 Dec 2017 23:54:50 -0600
Subject: [PATCH] Update docs building infra

This patch set migrates some of the file structure in compliance with
the Project Testing Interface (PTI) [0] for doc build in OpenStack-Infra.
See [1] for more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I5995ffd3a6821fd629e00351728c27a045a7c076
Signed-off-by: Tin Lam <tin@irrational.io>
---
 doc/requirements.txt  |  7 +++++++
 test-requirements.txt |  5 -----
 tox.ini               | 11 ++++++++---
 3 files changed, 15 insertions(+), 8 deletions(-)
 create mode 100644 doc/requirements.txt
 delete mode 100644 test-requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000000..6354511f45
--- /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.2 # BSD
+sphinxcontrib-blockdiag>=1.1.0
+oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.17.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
deleted file mode 100644
index 2363612449..0000000000
--- a/test-requirements.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-sphinx>=1.5.1,!=1.6.1 # BSD
-sphinxcontrib-blockdiag>=1.1.0
-oslosphinx>=4.7.0 # Apache-2.0
-pbr>=3.0.0 # Apache-2.0
-openstackdocstheme>=1.16.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 17de54d784..a738e33349 100644
--- a/tox.ini
+++ b/tox.ini
@@ -4,13 +4,18 @@ envlist = docs
 skipsdist = True
 
 [testenv]
-install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} -U {opts} {packages}
+install_command = pip install -U {opts} {packages}
 setenv = VIRTUAL_ENV={envdir}
-deps = -r{toxinidir}/test-requirements.txt
+deps = -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
 passenv = *_proxy *_PROXY
 
 [testenv:venv]
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands =
+  bash -c "rm -rf doc/build"
+  python setup.py build_sphinx
+whitelist_externals =
+  bash