Browse Source

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.

Also these changes remove a stale `setenv`.

[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: I7f1a14d57bdc15b3cf38bb6af8b76939ffdf7765
changes/75/769775/1
Hervé Beraud 5 months ago
parent
commit
455083be7e
3 changed files with 6 additions and 4 deletions
  1. +3
    -0
      doc/requirements.txt
  2. +0
    -3
      test-requirements.txt
  3. +3
    -1
      tox.ini

+ 3
- 0
doc/requirements.txt View File

@ -0,0 +1,3 @@
sphinx!=2.1.0,>=2.0.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
reno>=2.5.0 # Apache2

+ 0
- 3
test-requirements.txt View File

@ -6,9 +6,6 @@ hacking<3.1.0,>=3.0.0
coverage>=3.6
python-subunit>=0.0.18
sphinx!=2.1.0,>=2.0.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
reno>=2.5.0 # Apache2
oslotest>=1.10.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
testscenarios>=0.4


+ 3
- 1
tox.ini View File

@ -21,7 +21,6 @@ commands = {posargs}
[testenv:cover]
setenv =
{[testenv]setenv}
PYTHON=coverage run --source release_test --parallel-mode
commands =
stestr run {posargs}
@ -30,12 +29,15 @@ commands =
coverage xml -o cover/coverage.xml
[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:debug]
commands = oslo_debug_helper {posargs}
[testenv:releasenotes]
deps = {[testenv:docs]deps}
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[flake8]


Loading…
Cancel
Save