openstack
/
mistral-tempest-plugin
Code Issues Proposed changes

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: If027d55cea9fd88fadbb1539bbe713b2c2a7bd29
This commit is contained in:
caoyuan 2019-10-24 21:10:09 +08:00
parent 3c3a6cc2a1
commit 9bd2ff9607
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
test-requirements.txt
View File

@ -4,8 +4,8 @@
hacking>=1.1.0,<1.2.0 # 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
openstackdocstheme>=1.18.1 # Apache-2.0
# releasenotes

11
tox.ini
View File

@ -36,12 +36,19 @@ commands =
[testenv:docs]
basepython = python3
commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
whitelist_externals =
rm
commands =
rm -fr doc/build
sphinx-build -W -d doc/build/doctrees --keep-going -b html doc/source/ doc/build/html
[testenv:releasenotes]
basepython = python3
whitelist_externals =
rm
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
rm -rf releasenotes/build
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
[testenv:debug]
basepython = python3