whereto/tox.ini
jacky06 01a1742476 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 ==
3. update the url to latest

[1] sphinx-doc/sphinx@e3483e9

Change-Id: I337c1f756dde3ff6277b1e8d1ad1e3eff49a7e47
2019-10-16 21:22:29 +08:00

61 lines
1.5 KiB
INI

[tox]
minversion = 2.0
envlist = py27,py37,pep8
skipsdist = True
[testenv]
usedevelop = True
install_command = pip install {opts} {packages}
setenv =
VIRTUAL_ENV={envdir}
PYTHONWARNINGS=default::DeprecationWarning
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/requirements.txt
commands =
python setup.py test --coverage --coverage-package-name=whereto --slowest --testr-args='{posargs}'
coverage report --show-missing
[testenv:pep8]
basepython = python3
commands = flake8 {posargs}
[testenv:venv]
# The sphinxcontrib.autoprogram extension requires python 3's version
# of argparse, so force python 3 here to ensure the check job that
# builds the docs on OpenStack infrastructure uses python 3.
basepython = python3
commands = {posargs}
[testenv:bindep]
basepython = python3
deps = bindep
commands = bindep test
[testenv:cover]
basepython = python3
commands = python setup.py test --coverage --testr-args='{posargs}'
[testenv:docs]
basepython = python3
commands =
sphinx-build --keep-going -b html -W doc/source doc/build/html
[testenv:releasenotes]
basepython = python3
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
[testenv:debug]
basepython = python3
commands = oslo_debug_helper {posargs}
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125
builtins = _
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build