python-tripleoclient/tox.ini
Jiri Podivin cbf1231a08 Increased strictness of the doc build
Warnings are now turned into errors, failing
the doc build. This should prevent any more
syntax issues resulting in malformed, but still syntactically
valid, html output.

To aid with diagnosis of the failures:

The -E flag is now set to rebuild environment
from scratch for each run.

The `-a` flag is set to rebuild all html files,
regardless of their date.

The `--keep-going` flag is set so that the build
doesn't end after encountering first error, but
continues until the bitter end.

Depends-On: https://review.opendev.org/c/openstack/python-tripleoclient/+/789369

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: I591ca3686f72ed6c0426cf272adb8c95330509b5
2021-05-04 09:26:43 +02:00

94 lines
2.5 KiB
INI

[tox]
minversion = 3.2.0
envlist = pep8,py37,py36
skipsdist = True
# Automatic envs (pyXX) will only use the python version appropriate to that
# env and ignore basepython inherited from [testenv] if we set
# ignore_basepython_conflict.
ignore_basepython_conflict = True
[testenv]
basepython = python3
usedevelop = True
install_command = pip install {opts} {packages}
passenv =
TERM
setenv =
VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
HOME={envdir}
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands = stestr run {posargs}
[testenv:bindep]
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files.
deps = bindep
commands = bindep test
[testenv:pep8]
deps = pre-commit
commands = pre-commit run -a
[testenv:venv]
commands = {posargs}
passenv = *
[testenv:cover]
setenv =
PYTHON=coverage run --source tripleoclient --parallel-mode
HOME={envdir}
commands =
coverage erase
stestr run --color {posargs}
coverage combine
coverage html -d cover
coverage xml -o cover/coverage.xml
coverage report
[testenv:debug]
deps =
oslotest
{[testenv]deps}
commands = oslo_debug_helper -t tripleoclient/tests {posargs}
[testenv:docs]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -a -E -W --keep-going -b html doc/source doc/build/html
[testenv:pdf-docs]
whitelist_externals = make
description =
Build PDF documentation.
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
commands =
sphinx-build -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:genconfig]
setenv =
HOME={env:HOME:/home/stack}
commands =
oslo-config-generator --config-file config-generator/undercloud.conf
oslo-config-generator --config-file config-generator/standalone.conf
oslo-config-generator --config-file config-generator/minion.conf
[testenv:releasenotes]
deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html