diff options
| author | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:09:59 +0800 |
|---|---|---|
| committer | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:58:33 +0800 |
| commit | 31abe71ff6991a95750c436fdbcc9313341e4a65 (patch) | |
| tree | 6abb340e892d3621469e2ce7c253f088b91fb111 | |
| parent | 669e15036139a0418fb5db630a9f83fec3f7d505 (diff) | |
| download | oslo-middleware-31abe71ff6991a95750c436fdbcc9313341e4a65.tar.gz | |
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: Ic68b7acf92512255d4e1e3c2e5d3b6ff795e1354
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | tox.ini | 12 |
2 files changed, 12 insertions, 4 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index f8737ab..390e23d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,7 +3,7 @@ # process, which may cause wedges in the gate later. # These are needed for docs generation openstackdocstheme>=1.20.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,!=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 reno>=2.5.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD @@ -27,8 +27,12 @@ commands = {posargs} [testenv:docs] basepython = python3 +whitelist_externals = + rm deps = -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:cover] basepython = python3 @@ -46,8 +50,12 @@ import_exceptions = oslo_middleware._i18n [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:lower-constraints] basepython = python3 |