openstack/blazar
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: I84e64e1ba60341408c400bef7c351ec0ebab2ef1
This commit is contained in:
jacky06 2019-10-24 11:12:11 +08:00 committed by Pierre Riteau
parent b0b6e78ad3
commit 056b2efb14
3 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lower-constraints.txt
View File

@ -100,7 +100,7 @@ simplegeneric==0.8.1
simplejson==3.13.2
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
sqlalchemy-migrate==0.11.0
SQLAlchemy==1.0.10

3
test-requirements.txt
View File

@ -15,7 +15,6 @@ oslo.context>=2.19.2 # Apache-2.0
# Documentation
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0

6
tox.ini
View File

@ -51,7 +51,7 @@ commands =
deps = {[testenv:docs]deps}
whitelist_externals = make
commands =
sphinx-build -b latex doc/source doc/build/pdf
sphinx-build --keep-going -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:genconfig]
@ -79,14 +79,14 @@ deps = -r{toxinidir}/requirements.txt
commands = pylint blazar
[testenv:releasenotes]
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]
# This environment is called from CI scripts to test and publish
# the API Ref to docs.openstack.org.
commands =
rm -rf api-ref/build
sphinx-build -WE -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
sphinx-build -WE --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
[testenv:genpolicy]
commands =