From 10207be7b9d94041d91db5df9de417784dbfef16 Mon Sep 17 00:00:00 2001
From: Tin Lam <tin@irrational.io>
Date: Fri, 18 May 2018 18:30:30 -0500
Subject: [PATCH] docs(requirements): update requirements

This change migrates the docs building requirements as outlined in
the Project Testing Interface[0]. One benefit of this that we no longer
load all the doc-generating modules when we run tox unittest. 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: I0f4920df6ea68c289c82005d30ecd0efe0e29ca1
Signed-off-by: Tin Lam <tin@irrational.io>
---
 doc/requirements.txt | 7 +++++++
 tox.ini              | 3 ++-
 2 files changed, 9 insertions(+), 1 deletion(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 00000000..101a16ff
--- /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
+sphinxcontrib-apidoc>=0.2.0  # BSD
+sphinx_rtd_theme>=0.2.4
+reno>=2.5.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 3fb3b87b..c9dde653 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,9 +22,10 @@ commands =
     {toxinidir}/tools/run-unit-tests.sh {posargs}
 
 [testenv:docs]
+deps = -r{toxinidir}/doc/requirements.txt
 commands =
     rm -rf doc/build
-    python setup.py build_sphinx
+    sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:genconfig]
 commands =