diff options
| author | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:00:01 +0800 |
|---|---|---|
| committer | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:04:44 +0800 |
| commit | 0f7244f9dc4403109721d55c2be385d50f9ec9c0 (patch) | |
| tree | 6c0339b567b326cd23c1ee1ab7a789e02b8e3454 | |
| parent | 49ead48bbb75004379b877ad6552de3552097e6c (diff) | |
| download | oslo-config-0f7244f9dc4403109721d55c2be385d50f9ec9c0.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: Ied9f46640cf2f338a5784e1c72998f93b5c860c5
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | lower-constraints.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 5 |
3 files changed, 6 insertions, 5 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 880f44c..5d7ece7 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,8 +2,8 @@ # 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 sphinxcontrib-apidoc>=0.2.0 # BSD openstackdocstheme>=1.20.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/lower-constraints.txt b/lower-constraints.txt index 0174b10..6868685 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -44,7 +44,7 @@ rfc3986==1.2.0 six==1.10.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 +Sphinx==1.8.0 sphinxcontrib-websupport==1.0.1 stestr==2.1.0 stevedore==1.20.0 @@ -61,7 +61,7 @@ whitelist_externals = rm deps = -r{toxinidir}/doc/requirements.txt commands = rm -fr doc/build - sphinx-build -W -b html doc/source doc/build/html {posargs} + sphinx-build -W --keep-going -b html doc/source doc/build/html {posargs} [testenv:bandit] basepython = python3 @@ -75,7 +75,8 @@ exclude = .tox,dist,doc,*.egg,build [testenv:releasenotes] basepython = python3 deps = -r{toxinidir}/doc/requirements.txt -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 [hacking] import_exceptions = oslo_config._i18n |