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: Ifa4706d1191d56899e06ff77ea7b12936aac0328
This commit is contained in:
parent
30147030b2
commit
e63e75e938
@ -3,8 +3,8 @@
|
||||
# process, which may cause wedges in the gate later.
|
||||
# These are needed for docs generation
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
|
||||
sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
|
||||
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
|
||||
mock>=2.0.0 # BSD
|
||||
|
10
tox.ini
10
tox.ini
@ -23,14 +23,20 @@ commands = {posargs}
|
||||
commands = python setup.py test --coverage --coverage-package-name=oslo_versionedobjects --testr-args='{posargs}'
|
||||
|
||||
[testenv:docs]
|
||||
whitelist_externals = rm
|
||||
deps =
|
||||
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
commands =
|
||||
rm -fr doc/build
|
||||
sphinx-build -W --keep-going -b html doc/source doc/build/html
|
||||
|
||||
[testenv:releasenotes]
|
||||
whitelist_externals = rm
|
||||
deps = {[testenv:docs]deps}
|
||||
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||
commands =
|
||||
rm -rf releasenotes/build
|
||||
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
|
||||
|
||||
[testenv:lower-constraints]
|
||||
deps =
|
||||
|
Loading…
x
Reference in New Issue
Block a user