Add doc/requirements

We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removing specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug however it doesn't
produce any doc or releasenotes, but uniformization can't hurt and help
us in the future.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: I746d4b743924eefeb606e8516e2f60244b977c92
This commit is contained in:
Hervé Beraud 2021-01-07 16:07:40 +01:00
parent 5f3febe70f
commit fa7e59644d
3 changed files with 5 additions and 5 deletions

3
doc/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx!=1.6.6,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,>=1.6.2;python_version>='3.4' # BSD
sphinx_rtd_theme

View File

@ -4,8 +4,3 @@ fixtures>=0.3.14
python-subunit>=0.0.18
stestr
testtools>=0.9.36,!=1.2.0
# docs
sphinx!=1.6.6,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,>=1.6.2;python_version>='3.4' # BSD
sphinx_rtd_theme

View File

@ -22,6 +22,8 @@ basepython = python3
commands = {posargs}
[testenv:docs]
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:pep8]