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].
Removed 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.

[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: Ic771f9dfa0ee59c05f986bdbf24255dda87cc977
This commit is contained in:
Hervé Beraud 2021-01-07 14:22:49 +01:00 committed by Martin Chacon Piza
parent 298394511e
commit ed2c0d24f7
5 changed files with 9 additions and 7 deletions

3
doc/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0

View File

@ -1,5 +1,5 @@
alabaster==0.7.10
appdirs==1.3.0
appdirs==1.4.0
Babel==2.3.4
bandit==1.4.0
coverage==4.0
@ -16,7 +16,7 @@ Jinja2==2.10
keystoneauth1==3.4.0
linecache2==1.0.0
MarkupSafe==1.0
mccabe==0.2.1
mccabe==0.6.0
mox3==0.20.0
openstackdocstheme==1.18.1
os-client-config==1.28.0
@ -31,7 +31,7 @@ pytz==2013.6
PyYAML==3.12
requests==2.14.2
requestsexceptions==1.2.0
six==1.10.0
six==1.12.0
smmap==0.9.0
snowballstemmer==1.2.1
Sphinx==1.6.5

View File

@ -1,4 +1,4 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
six>=1.10.0 # MIT
six>=1.12.0 # MIT

View File

@ -4,9 +4,6 @@
hacking>=3.0.1,<3.1.0 # Apache-2.0
bandit>=1.1.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
oslosphinx>=4.7.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
stestr>=1.0.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
openstackdocstheme>=1.18.1 # Apache-2.0

View File

@ -39,6 +39,8 @@ commands =
oslo_debug_helper -t {toxinidir}/tests {posargs}
[testenv:docs]
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build
python setup.py build_sphinx