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: I6bdfa9830a32ecf36e1931e1bb0afa366f1dfeb9
This commit is contained in:
parent
213087869a
commit
b0d5e455fc
|
@ -0,0 +1,7 @@
|
|||
sphinx>=3.3.1 # BSD
|
||||
openstackdocstheme>=2.2.6 # Apache-2.0
|
||||
sphinxcontrib-httpdomain>=1.7.0 # BSD
|
||||
sphinxcontrib-pecanwsme>=0.10.0 # Apache-2.0
|
||||
reno>=3.2.0 # Apache-2.0
|
||||
Pygments>=2.7.2 # BSD license
|
||||
os-api-ref>=2.1.0 # Apache-2.0
|
|
@ -11,13 +11,6 @@ ddt>=1.4.1 # MIT
|
|||
gabbi>=2.0.4 # Apache-2.0
|
||||
testscenarios>=0.5.0 # Apache-2.0/BSD
|
||||
stestr>=3.0.1 # Apache-2.0
|
||||
sphinx>=3.3.1 # BSD
|
||||
openstackdocstheme>=2.2.6 # Apache-2.0
|
||||
oslotest>=4.4.1 # Apache-2.0
|
||||
sphinxcontrib-httpdomain>=1.7.0 # BSD
|
||||
sphinxcontrib-pecanwsme>=0.10.0 # Apache-2.0
|
||||
reno>=3.2.0 # Apache-2.0
|
||||
doc8>=0.8.1 # Apache-2.0
|
||||
Pygments>=2.7.2 # BSD license
|
||||
os-api-ref>=2.1.0 # Apache-2.0
|
||||
bandit>=1.6.0 # Apache-2.0
|
||||
|
|
3
tox.ini
3
tox.ini
|
@ -51,6 +51,8 @@ commands =
|
|||
commands = oslopolicy-sample-generator --config-file=etc/oslo-policy-generator/cloudkitty.conf
|
||||
|
||||
[testenv:docs]
|
||||
deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -W --keep-going -b html doc/source doc/build/html
|
||||
|
||||
# TODO(smcginnis) Temporarily disabling this as it fails. Error is that
|
||||
|
@ -92,6 +94,7 @@ extension =
|
|||
paths = ./cloudkitty/hacking
|
||||
|
||||
[testenv:releasenotes]
|
||||
deps = {[testenv:docs]deps}
|
||||
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
|
||||
|
||||
[testenv:lower-constraints]
|
||||
|
|
Loading…
Reference in New Issue