From bf379ee6cc894061ad4024b7c3eae52235eb87c7 Mon Sep 17 00:00:00 2001 From: gujin Date: Fri, 25 Oct 2019 23:54:40 +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: I9c2c81c6f6e3064e91ceb1704e4b7cdf86fa8f01 --- doc/requirements.txt | 4 ++-- tox.ini | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 8dd3be33d..b63aa1cf1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. # this is required for the docs build jobs -openstackdocstheme>=1.20.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD +sphinx>=1.8.0,!=2.1.0 # BSD reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index c02b2678e..3bb918e2d 100644 --- a/tox.ini +++ b/tox.ini @@ -57,18 +57,18 @@ 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 + sphinx-build -W --keep-going -b html doc/source doc/build/html whitelist_externals = rm [testenv:releasenotes] deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [testenv:api-ref] deps = -r{toxinidir}/doc/requirements.txt commands = - 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 [flake8] # Temporarily disable complaints about docstring for public module/class/method