diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2019-07-11 15:51:30 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2019-07-18 10:26:15 +0100 |
| commit | 81dff47a190bea2e550fb9fcc061d0a45e22a617 (patch) | |
| tree | ed9960d267e9f9a4e7e75fb6c6c00671be18ee41 /tox.ini | |
| parent | 15e082a2a87c87d2d30d13936bbda06489b4edcc (diff) | |
| download | nova-81dff47a190bea2e550fb9fcc061d0a45e22a617.tar.gz | |
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: Idc38751e1629947f5842651d99b1528f74247b42
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -172,7 +172,7 @@ commands = bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'" # Check that all included JSON files are valid JSON bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python' - sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html + sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html # Test the redirects. This must run after the main docs build whereto doc/build/html/.htaccess doc/test/redirect-tests.txt @@ -183,7 +183,7 @@ envdir = {toxworkdir}/docs deps = {[testenv:docs]deps} commands = rm -rf api-guide/build - sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html + sphinx-build -W --keep-going -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html [testenv:api-ref] description = @@ -192,7 +192,7 @@ envdir = {toxworkdir}/docs deps = {[testenv:docs]deps} 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:releasenotes] description = @@ -201,7 +201,7 @@ envdir = {toxworkdir}/docs deps = {[testenv:docs]deps} commands = rm -rf releasenotes/build - sphinx-build -W -b html -d releasenotes/build/doctrees releasenotes/source releasenotes/build/html + sphinx-build -W --keep-going -b html -d releasenotes/build/doctrees releasenotes/source releasenotes/build/html [testenv:all-docs] description = |