diff options
| author | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 13:54:55 +0800 |
|---|---|---|
| committer | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 13:58:31 +0800 |
| commit | ec52c3b5dc94baed69de0de80f6c57bc244eaf25 (patch) | |
| tree | 780456533877abe2c594b64111b2123c3914227a | |
| parent | e49eca232f272f011bdbfdf2770c45cb7c90bd20 (diff) | |
| download | oslo-concurrency-ec52c3b5dc94baed69de0de80f6c57bc244eaf25.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: Id12730272782a7cfda89cba79d40919e2a5ecd24
| -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 25408d9..00b94af 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. # this is required for the docs build jobs -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 reno>=2.5.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD diff --git a/lower-constraints.txt b/lower-constraints.txt index 0c9143b..27ecde6 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -51,7 +51,7 @@ rfc3986==0.3.1 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 stevedore==1.20.0 stestr==2.0.0 @@ -38,7 +38,7 @@ 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:cover] basepython = python3 @@ -62,7 +62,8 @@ import_exceptions = [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 [testenv:lower-constraints] basepython = python3 |