Skip to content

Commit 3e7f7a0

Browse files
caoyuanlukapeschke
authored andcommitted
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] sphinx-doc/sphinx@e3483e9b045 Change-Id: Ie373018aafc05f7ea859a73c55163840dee60b56
1 parent 5840467 commit 3e7f7a0

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

doc/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# process, which may cause wedges in the gate later.
44

55
openstackdocstheme>=1.30.0 # Apache-2.0
6-
sphinx>=1.6.2,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
7-
sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
6+
sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
7+
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
88
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
99
reno>=2.5.0 # Apache-2.0

tox.ini

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ commands = {posargs}
4949
[testenv:docs]
5050
basepython = python3
5151
deps = -r{toxinidir}/doc/requirements.txt
52-
commands = sphinx-build -W -b html doc/source doc/build/html
52+
commands = sphinx-build -W --keep-going -b html doc/source doc/build/html
5353

5454
[testenv:pdf-docs]
5555
basepython = python3
@@ -58,7 +58,7 @@ deps = {[testenv:docs]deps}
5858
whitelist_externals =
5959
make
6060
commands =
61-
sphinx-build -W -b latex doc/source doc/build/pdf
61+
sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
6262
make -C doc/build/pdf
6363

6464
[flake8]
@@ -77,7 +77,8 @@ basepython = python3
7777
deps =
7878
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
7979
-r{toxinidir}/doc/requirements.txt
80-
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
80+
commands =
81+
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
8182

8283
[testenv:lower-constraints]
8384
basepython = python3

0 commit comments

Comments
 (0)