From 44bd4e5deb218ca4f500a69a57aceb4f0ff220f2 Mon Sep 17 00:00:00 2001 From: caoyuan Date: Thu, 24 Oct 2019 20:41:46 +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: Ifa044174c197f10c88947865508379c5b53c6090 --- doc/requirements.txt | 2 +- tox.ini | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 5686a84..ab41b76 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,3 @@ -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 32a08f0..4757c8b 100644 --- a/tox.ini +++ b/tox.ini @@ -39,7 +39,7 @@ basepython = python3 setenv = DJANGO_SETTINGS_MODULE=congress_dashboard.test.settings 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 [testenv:pdf-docs] basepython = python3 @@ -48,13 +48,14 @@ deps = {[testenv:docs]deps} whitelist_externals = make commands = - sphinx-build -W -b latex doc/source doc/build/pdf + sphinx-build -W --keep-going -b latex doc/source doc/build/pdf make -C doc/build/pdf [testenv:releasenotes] basepython = python3 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 [flake8] # F405 TEMPLATES may be undefined, or defined from star imports