From: Ben Darnell <ben@bendarnell.com>
Date: Sat, 15 Sep 2018 20:31:45 +0000 (-0400)
Subject: docs: Pin sphinx 1.7
X-Git-Tag: v6.0.0b1~33^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2490%2Fhead;p=thirdparty%2Ftornado.git

docs: Pin sphinx 1.7

The build currently fails on 1.8 due to https://bugs.python.org/issue34700
---

diff --git a/.travis.yml b/.travis.yml
index 40298e2f8..e200778a3 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -47,7 +47,7 @@ install:
     # Ideally we'd run the docs/lint stuff on the latest Python
     # version supported. But Python 3.7 requires slower-to-start VMs,
     # so we run it on 3.6 to minimize total CI run time.
-    - if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then travis_retry pip install sphinx sphinx_rtd_theme; fi
+    - if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then travis_retry pip install -r docs/requirements.txt; fi
     - if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then travis_retry pip install flake8 mypy; fi
     # On travis the extension should always be built
     - if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then export TORNADO_EXTENSION=1; fi
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 082785c97..d5626da3c 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1 +1,4 @@
+# https://bugs.python.org/issue34700
+sphinx<1.8.0
+sphinx_rtd_theme
 Twisted
diff --git a/tox.ini b/tox.ini
index ee44788e9..b3defc065 100644
--- a/tox.ini
+++ b/tox.ini
@@ -61,8 +61,7 @@ deps =
      {py35,py36,py37}-full: twisted
      py3: twisted
      {py3,py35,py36,py37}-full: pycares
-     sphinx: sphinx
-     sphinx: sphinx_rtd_theme
+     sphinx: -r{toxinidir}/docs/requirements.txt
      lint: flake8
 
 setenv =