From c5e65f3ff57996d7ea7be98c7ce41a1abf1e5680 Mon Sep 17 00:00:00 2001 From: caoyuan Date: Thu, 24 Oct 2019 13:32:54 +0800 Subject: [PATCH] tox: Keeping going with docs Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Change-Id: Ia9273b02cd56352ca7628d95afa4a2062f4daa22 --- doc/requirements.txt | 4 ++-- lower-constraints.txt | 2 +- test-requirements.txt | 4 ++-- tox.ini | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index cd98c3b238..74352370e3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,6 +4,6 @@ openstackdocstheme>=1.20.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD +sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD reno>=2.5.0 # Apache-2.0 diff --git a/lower-constraints.txt b/lower-constraints.txt index 565281b50b..99e3f7e628 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -144,7 +144,7 @@ simplejson==3.13.2 six==1.10.0 smmap2==2.0.3 snowballstemmer==1.2.1 -Sphinx==1.6.2 +Sphinx==1.8.0 sphinxcontrib-websupport==1.0.1 sqlalchemy-migrate==0.11.0 SQLAlchemy==1.0.10 diff --git a/test-requirements.txt b/test-requirements.txt index d966d21fa1..95591f30a6 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,8 +17,8 @@ osprofiler>=1.4.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD pytz>=2013.6 # MIT -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD testrepository>=0.0.18 # Apache-2.0/BSD stestr>=2.0.0 # Apache-2.0 testscenarios>=0.4 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index a9b1b2c08e..f01e6f1664 100644 --- a/tox.ini +++ b/tox.ini @@ -129,7 +129,7 @@ commands = {toxinidir}/tools/cover.sh {posargs} [testenv:docs] deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -W -b html doc/source doc/build/html +commands = sphinx-build -W --keep-going -b html doc/source doc/build/html [testenv:pdf-docs] basepython = python3 @@ -172,16 +172,16 @@ commands=pip-missing-reqs -d --ignore-file=magnum/tests/* magnum deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf releasenotes/build - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [testenv:install-guide] -commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html +commands = sphinx-build -a -E -W -d install-guide/build/doctrees --keep-going -b html install-guide/source install-guide/build/html [testenv:api-ref] deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf api-ref/build - sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + sphinx-build -W --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:lower-constraints] deps =