tox: Keeping going with docs
1. 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. 2. Remove the unnecessary blank line for tox.ini [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Depends-On: Ie837d376bb1a1d93367369d25140dd8a9d5ac14e Change-Id: I792d057fab99ed6226a10d8912be274a7192c2b1
This commit is contained in:
parent
8e64de671a
commit
0b8233bc44
10
tox.ini
10
tox.ini
@ -3,7 +3,6 @@ minversion = 2.0
|
||||
skipsdist = True
|
||||
envlist = docs,linters
|
||||
|
||||
|
||||
[testenv]
|
||||
usedevelop = True
|
||||
install_command =
|
||||
@ -28,47 +27,40 @@ setenv =
|
||||
VIRTUAL_ENV={envdir}
|
||||
WORKING_DIR={toxinidir}
|
||||
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python3
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands=
|
||||
bash -c "rm -rf doc/build"
|
||||
doc8 doc
|
||||
sphinx-build -b html doc/source doc/build/html
|
||||
|
||||
sphinx-build --keep-going -b html doc/source doc/build/html
|
||||
|
||||
[doc8]
|
||||
# Settings for doc8:
|
||||
extensions = .rst
|
||||
|
||||
|
||||
# environment used by the -infra templated docs job
|
||||
[testenv:venv]
|
||||
basepython = python3
|
||||
commands =
|
||||
{posargs}
|
||||
|
||||
|
||||
[testenv:pep8]
|
||||
basepython = python3
|
||||
commands =
|
||||
bash -c "{toxinidir}/tests/common/test-pep8.sh"
|
||||
|
||||
|
||||
[flake8]
|
||||
# Ignores the following rules due to how ansible modules work in general
|
||||
# F403 'from ansible.module_utils.basic import *' used;
|
||||
# unable to detect undefined names
|
||||
ignore=F403
|
||||
|
||||
|
||||
[testenv:bashate]
|
||||
basepython = python3
|
||||
commands =
|
||||
bash -c "{toxinidir}/tests/common/test-bashate.sh"
|
||||
|
||||
|
||||
[testenv:linters]
|
||||
basepython = python3
|
||||
commands =
|
||||
|
Loading…
Reference in New Issue
Block a user