diff options
| author | jacky06 <zhang.min@99cloud.net> | 2019-10-14 18:22:46 +0800 |
|---|---|---|
| committer | jacky06 <zhang.min@99cloud.net> | 2019-10-14 18:32:14 +0800 |
| commit | 75d70a0c8a1a15d5a8707008635c97d2fba21382 (patch) | |
| tree | c0b03ba5966bb36cdd9c68cad2de76da0ec3b5a9 | |
| parent | cf525a990059b684dae971a1905ea280d4866ed5 (diff) | |
| download | kolla-75d70a0c8a1a15d5a8707008635c97d2fba21382.tar.gz kolla-75d70a0c8a1a15d5a8707008635c97d2fba21382.zip | |
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: I6b8897472220e2f45ec3230be8d3f82adacc7c7e
| -rw-r--r-- | doc/requirements.txt | 5 | ||||
| -rw-r--r-- | tox.ini | 6 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index ce8957d82..c36e117d7 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,9 +1,10 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. + doc8>=0.6.0 # Apache-2.0 openstackdocstheme>=1.19.0 # Apache-2.0 reno>=2.5.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,!=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-svg2pdfconverter>=0.1.0 # BSD @@ -73,14 +73,14 @@ deps = commands = rm -rf doc/build doc8 doc - sphinx-build -W -b html doc/source doc/build/html + sphinx-build -W --keep-going -b html doc/source doc/build/html [testenv:pdf-docs] basepython = python3 whitelist_externals = make deps = {[testenv:docs]deps} commands = - sphinx-build -W -b latex doc/source doc/build/pdf + sphinx-build -W --keep-going -b latex doc/source doc/build/pdf make -C doc/build/pdf [testenv:build-centos-binary] @@ -153,7 +153,7 @@ basepython = python3 deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf releasenotes/build - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [testenv:bindep] basepython = python3 |