diff options
| author | Hervé Beraud <hberaud@redhat.com> | 2021-01-07 16:31:30 +0100 |
|---|---|---|
| committer | Douglas Mendizábal <dmendiza@redhat.com> | 2022-09-16 15:39:19 +0000 |
| commit | fab802e0f4c8c6fa8f22fefdc53362267f63e93b (patch) | |
| tree | bdfb615fcfce8781f1b398dfcb6224d58a0883f1 | |
| parent | 25c95e722176d876583bddf640144eec32156927 (diff) | |
| download | pycadf-fab802e0f4c8c6fa8f22fefdc53362267f63e93b.tar.gz | |
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.
[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: I11c1f9816ad93f7c3a7d9de5894746d48154e18d
| -rw-r--r-- | doc/requirements.txt | 3 | ||||
| -rw-r--r-- | test-requirements.txt | 5 | ||||
| -rw-r--r-- | tox.ini | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..38e1b02 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/test-requirements.txt b/test-requirements.txt index 0d0f7f6..37e0ee8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,8 +10,3 @@ fixtures>=3.0.0 # Apache-2.0/BSD python-subunit>=1.0.0 # Apache-2.0/BSD stestr>=2.0.0 # Apache-2.0 testtools>=2.2.0 # MIT - -# this is required for the docs build jobs -openstackdocstheme>=2.2.1 # Apache-2.0 -sphinx>=2.0.0,!=2.1.0 # BSD -sphinxcontrib-apidoc>=0.2.0 # BSD @@ -15,6 +15,8 @@ commands = stestr run --slowest {posargs} commands = flake8 [testenv:docs] +deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt whitelist_externals = rm commands = |