Define constraints file for docs and renos

Right now we are not using any constraints for docs and releasenotes builds.
This has resulted in docs job failures once Sphinx 7.2.0 has been released.

The patch will ensure that constraints are used an we should not face
simmilar issue again.

TOX_CONSTRAINTS_FILE is updated by Release bot once new branch is created,
so it should always track relevant constraints.

Some extra syntax-related changes can apply, since patch is being passed
through ConfigParser, that does not preserve comments and align indenting.


Change-Id: Ia704b63838c8730039e135eb38e170204d5a30e2
This commit is contained in:
Dmitriy Rabotyagov 2023-08-17 16:32:22 +02:00
parent d94e57f17b
commit 138696d0f5

21
tox.ini
View File

@ -31,7 +31,9 @@ setenv =
WORKING_DIR={toxinidir} WORKING_DIR={toxinidir}
[testenv:docs] [testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt deps =
-r{toxinidir}/doc/requirements.txt
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
commands = commands =
bash -c "rm -rf doc/build" bash -c "rm -rf doc/build"
sphinx-build -W --keep-going -b html doc/source doc/build/html sphinx-build -W --keep-going -b html doc/source doc/build/html
@ -39,21 +41,21 @@ commands =
[testenv:pdf-docs] [testenv:pdf-docs]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}
allowlist_externals = allowlist_externals =
make make
commands = commands =
sphinx-build -W --keep-going -b latex doc/source doc/build/pdf sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
make -C doc/build/pdf make -C doc/build/pdf
[doc8] [doc8]
# Settings for doc8:
extensions = .rst extensions = .rst
[testenv:releasenotes] [testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt deps =
-r{toxinidir}/doc/requirements.txt
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
commands = commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -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
[testenv:venv] [testenv:venv]
commands = commands =
{posargs} {posargs}
@ -63,10 +65,7 @@ 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 ignore = F403
# F403 'from ansible.module_utils.basic import *' used;
# unable to detect undefined names
ignore=F403
[testenv:bashate] [testenv:bashate]
commands = commands =