From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Wed, 12 Sep 2018 21:10:33 +0000 (-0400)
Subject: Pin Sphinx to version <1.8.0
X-Git-Tag: v0.2.4~1
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=240ae4b5acd57b45dfba899ccbc7212a91854d42;p=releng%2Fdocs-conf.git

Pin Sphinx to version <1.8.0

The new 1.8.0 release of Sphinx is breaking builds in our CI.

In order to get tox runs to pass, the requirement files need to be split
apart and Sphinx version explicitly set for coala. This is due to some
coala bear requiring a version of Sphinx <1.5, which appears to get
pulled in from the base requirements.txt file.

This patch also includes minor clean up of the tox.ini file and a
pyflake validation fix.

Change-Id: Iea9b870270d7a8954f611aaca451de653397397a
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
---

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..e68bd8c
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx~=1.7.9
+sphinx_bootstrap_theme>=0.6.2
diff --git a/docs_conf/conf.py b/docs_conf/conf.py
index 22a9da0..c27ff24 100644
--- a/docs_conf/conf.py
+++ b/docs_conf/conf.py
@@ -17,9 +17,10 @@ Configure sphinx-doc through an YAML file.
 import imp
 import os.path
 
-import sphinx_bootstrap_theme
 import yaml
 
+import sphinx_bootstrap_theme
+
 
 def _merge_yaml(x, y):
     """Merge dictionary 'y' into 'x'.
diff --git a/requirements.txt b/requirements.txt
index 7707881..35aaeb5 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,2 @@
 pytest
 pyyaml
-Sphinx
-sphinx_bootstrap_theme>=0.6.2
diff --git a/tox.ini b/tox.ini
index 006b2b6..f8d9dd3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -4,11 +4,12 @@ envlist =
     check-hooks,
     coala,
     docs,
-    docs-linkcheck,
     py27
 
 [testenv]
-deps = -rrequirements.txt
+deps =
+  -rrequirements.txt
+  -rdocs/requirements.txt
 commands =
     pytest --basetemp={envtmpdir} {posargs}
 
@@ -23,6 +24,7 @@ basepython = python3
 deps =
     coala
     coala-bears
+    Sphinx<1.5,>=1.3
     nodeenv==1.1.2
 commands =
     nodeenv -p
@@ -30,7 +32,7 @@ commands =
     coala --non-interactive
 
 [testenv:docs]
-deps = -rrequirements.txt
+deps = -rdocs/requirements.txt
 commands =
     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"