openstack/openstack-ansible-pip_install
Code Issues Proposed changes

tox: Keeping going with docs

Browse Source 
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: I93c41550963f60155e3062c702256366d3cbcdf7
This commit is contained in:
jacky06 2019-10-24 01:22:59 +08:00
parent 9ba2b5d546
commit 7a9f2182c1
1 changed files with 2 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tox.ini
View File

@ -3,7 +3,6 @@ minversion = 2.0
skipsdist = True skipsdist = True
envlist = docs,linters,functional envlist = docs,linters,functional
[testenv] [testenv]
usedevelop = True usedevelop = True
install_command = install_command =
@ -31,27 +30,23 @@ setenv =
VIRTUAL_ENV={envdir} VIRTUAL_ENV={envdir}
WORKING_DIR={toxinidir} WORKING_DIR={toxinidir}
[testenv:docs] [testenv:docs]
basepython = python3 basepython = python3
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt
commands= commands=
bash -c "rm -rf doc/build" bash -c "rm -rf doc/build"
doc8 doc doc8 doc
sphinx-build -b html doc/source doc/build/html sphinx-build --keep-going -b html doc/source doc/build/html
[doc8] [doc8]
# Settings for doc8: # Settings for doc8:
extensions = .rst extensions = .rst
[testenv:releasenotes] [testenv:releasenotes]
basepython = python3 basepython = python3
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt
commands = commands =
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
# environment used by the -infra templated docs job # environment used by the -infra templated docs job
[testenv:venv] [testenv:venv]
@ -59,43 +54,36 @@ basepython = python3
commands = commands =
{posargs} {posargs}
[testenv:pep8] [testenv:pep8]
basepython = python3 basepython = python3
commands = commands =
bash -c "{toxinidir}/tests/common/test-pep8.sh" bash -c "{toxinidir}/tests/common/test-pep8.sh"
[flake8] [flake8]
# Ignores the following rules due to how ansible modules work in general # Ignores the following rules due to how ansible modules work in general
# F403 'from ansible.module_utils.basic import *' used; # F403 'from ansible.module_utils.basic import *' used;
# unable to detect undefined names # unable to detect undefined names
ignore=F403 ignore=F403
[testenv:bashate] [testenv:bashate]
basepython = python3 basepython = python3
commands = commands =
bash -c "{toxinidir}/tests/common/test-bashate.sh" bash -c "{toxinidir}/tests/common/test-bashate.sh"
[testenv:ansible-syntax] [testenv:ansible-syntax]
basepython = python3 basepython = python3
commands = commands =
bash -c "{toxinidir}/tests/common/test-ansible-syntax.sh" bash -c "{toxinidir}/tests/common/test-ansible-syntax.sh"
[testenv:ansible-lint] [testenv:ansible-lint]
basepython = python3 basepython = python3
commands = commands =
bash -c "{toxinidir}/tests/common/test-ansible-lint.sh" bash -c "{toxinidir}/tests/common/test-ansible-lint.sh"
[testenv:functional] [testenv:functional]
commands = commands =
bash -c "{toxinidir}/tests/common/test-ansible-functional.sh" bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
[testenv:linters] [testenv:linters]
basepython = python3 basepython = python3
commands = commands =