From 6e8921812599f9f51cd7e90c8bbb2291a206ed5b Mon Sep 17 00:00:00 2001 From: caoyuan Date: Thu, 24 Oct 2019 21:10:11 +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: Ife98c47af59355540fa30d7ca762f857759c1274 --- doc/requirements.txt | 4 ++-- lower-constraints.txt | 2 +- tox.ini | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 0297e4d0b..0c8105fc3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # 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 sphinxcontrib-httpdomain>=1.3.0 # BSD sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0 openstackdocstheme>=1.30.0 # Apache-2.0 diff --git a/lower-constraints.txt b/lower-constraints.txt index be69e9429..f2de041e1 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -148,7 +148,7 @@ simplegeneric==0.8.1 simplejson==3.5.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 +Sphinx==1.8.0 sphinxcontrib-httpdomain==1.3.0 sphinxcontrib-pecanwsme==0.10.0 sphinxcontrib-websupport==1.0.1 diff --git a/tox.ini b/tox.ini index a99d5c393..c51488c3f 100644 --- a/tox.ini +++ b/tox.ini @@ -78,13 +78,13 @@ deps = -r{toxinidir}/doc/requirements.txt setenv = PYTHONHASHSEED=0 commands = rm -rf doc/build - sphinx-build -E -W -b html doc/source doc/build/html + sphinx-build -E -W --keep-going -b html doc/source doc/build/html [testenv:releasenotes] basepython = python3 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:api-ref] basepython = python3 @@ -92,7 +92,7 @@ basepython = python3 # the API Ref to docs.openstack.org. 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 whitelist_externals = rm #Skip PEP257 violation.