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:28:28 +0800 |
| commit | 9a5f153c4b3fc51f4bdf3d96965bdd25a2f45f92 (patch) | |
| tree | 7ba529408f4a92702b24f0be36be2baaed505aa2 | |
| parent | be28e3eaf7f96296d52db4e50837bbcfded9694f (diff) | |
| download | oslo-db-9a5f153c4b3fc51f4bdf3d96965bdd25a2f45f92.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: Idaca0bc97e33e0a080de612420177b5e102c628c
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | tox.ini | 8 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 024debe..005a64e 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. openstackdocstheme>=1.18.1 # 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 doc8>=0.6.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 sphinxcontrib-apidoc>=0.2.0 # BSD @@ -56,12 +56,16 @@ deps = commands = rm -rf doc/build doc/source/reference/api doc8 -e .rst CONTRIBUTING.rst HACKING.rst README.rst doc/source - sphinx-build -W -b html doc/source doc/build/html + sphinx-build -W --keep-going -b html doc/source doc/build/html [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 [flake8] # E123, E125 skipped as they are invalid PEP-8. |