diff options
author | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 19:31:18 +0800 |
---|---|---|
committer | caoyuan <cao.yuan@99cloud.net> | 2019-11-01 11:30:12 +0800 |
commit | eb10545b372a936aa551acf03eebd250318aa3a5 (patch) | |
tree | 0fe5b215fe60c7300645e599afd5a94d64ca9f8b /tox.ini | |
parent | 491e2fb47011a55e06908a417534ca51b4b057ef (diff) | |
download | heat-eb10545b372a936aa551acf03eebd250318aa3a5.tar.gz |
tox: Keeping going with docs
1. 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.
2. Add whitelist_externals to fix the warning
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: I47683ab1313981a8202afe6b3fe1779d40340452
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 12 |
1 files changed, 9 insertions, 3 deletions
@@ -66,10 +66,12 @@ commands = [testenv:docs] basepython = python3 +whitelist_externals = + rm deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf doc/build - sphinx-build -W -b html doc/source doc/build/html + sphinx-build -W --keep-going -b html doc/source doc/build/html [testenv:api-ref] basepython = python3 @@ -80,7 +82,7 @@ whitelist_externals = bash rm commands = rm -rf api-ref/build - sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + sphinx-build -W --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:genconfig] basepython = python3 @@ -130,8 +132,12 @@ commands = oslo_debug_helper {posargs} [testenv:releasenotes] basepython = python3 +whitelist_externals = + rm deps = -r{toxinidir}/doc/requirements.txt -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:bindep] basepython = python3 |