openstack/cloudkitty
Code Issues Proposed changes

tox: Keeping going with docs

Browse Source 
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: Ic3a57b513d3646b6931edc6163c2702805d29d57
This commit is contained in:
caoyuan 2019-10-24 20:45:38 +08:00
parent 8a0f80ad91
commit 05eb7b9a58
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lower-constraints.txt
View File

@ -40,7 +40,7 @@ gabbi==1.26.1 # Apache-2.0
testscenarios==0.4 # Apache-2.0/BSD
stestr==2.0.0 # Apache-2.0
mock==1.2 # BSD
sphinx==1.6.2 # BSD
sphinx==1.8.0 # BSD
openstackdocstheme==1.30.0 # Apache-2.0
oslotest==1.10.0 # Apache-2.0
sphinxcontrib-pecanwsme==0.8 # Apache-2.0

2
test-requirements.txt
View File

@ -12,7 +12,7 @@ gabbi>=1.26.1 # Apache-2.0
testscenarios>=0.4 # Apache-2.0/BSD
stestr>=2.0.0 # Apache-2.0
mock>=1.2 # BSD
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.30.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
sphinxcontrib-httpdomain>=1.6.0 # BSD

6
tox.ini
View File

@ -49,14 +49,14 @@ commands =
commands = oslopolicy-sample-generator --config-file=etc/oslo-policy-generator/cloudkitty.conf
[testenv:docs]
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]
envdir = {toxworkdir}/docs
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:venv]
@ -74,7 +74,7 @@ import_exceptions = cloudkitty.i18n
local-check-factory = cloudkitty.hacking.checks.factory
[testenv:releasenotes]
commands = sphinx-build -a -E -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:lower-constraints]
deps =