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:54:15 +0800 |
| commit | e6fe8b29ec2aa0277c4a140c07878f764ebbb08c (patch) | |
| tree | c43d4eff2457ac4813d8dc70dbe5169c545cdd15 | |
| parent | 0f7e144d013155f27f74b0eb91b7ae0f1530a86b (diff) | |
| download | oslo-policy-e6fe8b29ec2aa0277c4a140c07878f764ebbb08c.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: I9af0e8323b85d47983274b4d45b27f6c036ea5a8
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | lower-constraints.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 8 |
3 files changed, 9 insertions, 5 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index c843563..cef9853 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,8 +3,8 @@ # process, which may cause wedges in the gate later. openstackdocstheme>=1.18.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.5,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.5;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 sphinxcontrib-apidoc>=0.2.0 # BSD reno>=2.5.0 # Apache-2.0 diff --git a/lower-constraints.txt b/lower-constraints.txt index 04c5324..d6d0429 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -51,7 +51,7 @@ six==1.10.0 stestr==2.0.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 +Sphinx==1.8.0 sphinxcontrib-websupport==1.0.1 stevedore==1.20.0 testrepository==0.0.18 @@ -36,7 +36,7 @@ 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:cover] basepython = python3 @@ -54,7 +54,11 @@ import_exceptions = oslo_policy._i18n [testenv:releasenotes] basepython = python3 -commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +whitelist_externals = + rm +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 |