tox: Keeping going with docs

Code Issues Proposed changes

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: Id7784670604631d1fb702d2a33cfe91aa4d10987

This commit is contained in:

caoyuan

2019年10月24日 20:24:12 +08:00

parent a012e0a675

commit b5ca8f9013

2 changed files with 4 additions and 4 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt

View File

@@ -2,6 +2,6 @@

# of appearance. Changing the order has an impact on the overall integration

# process, which may cause wedges in the gate later.

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,!=2.1.0,>=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.20.0 # Apache-2.0

4
tox.ini

View File

@@ -41,13 +41,13 @@ commands =

coverage report

[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:docs]

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

whitelist_externals = rm

[testenv:debug]