diff options
| author | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:10:19 +0800 |
|---|---|---|
| committer | caoyuan <cao.yuan@99cloud.net> | 2019-10-24 14:50:28 +0800 |
| commit | 127ded28c98f1989e89094fbde8a955c07d1915d (patch) | |
| tree | 5eea589b93f4c27553ec6e4e9d2f5b399860bfe4 | |
| parent | 63b75327acbb1ca0c7aa35d83ec5ebf8ac11af97 (diff) | |
| download | oslo-vmware-127ded28c98f1989e89094fbde8a955c07d1915d.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: I390f8f7add7530f1442f66816389202e3ed21f05
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | lower-constraints.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 7 |
3 files changed, 8 insertions, 5 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 758afce..66106c1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,8 +3,8 @@ # 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,>=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 sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/lower-constraints.txt b/lower-constraints.txt index 4200165..cdafddd 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -47,7 +47,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 stestr==2.0.0 stevedore==1.20.0 @@ -32,7 +32,7 @@ deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf doc/build doc/source/reference/api - 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 @@ -59,10 +59,13 @@ local-check-factory = oslo_vmware.hacking.checks.factory [testenv:releasenotes] basepython = python3 +whitelist_externals = rm deps = -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} -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:bindep] basepython = python3 |