summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHervé Beraud <hberaud@redhat.com>2021-01-07 16:31:30 +0100
committerDouglas Mendizábal <dmendiza@redhat.com>2022-09-16 15:39:19 +0000
commitfab802e0f4c8c6fa8f22fefdc53362267f63e93b (patch)
treebdfb615fcfce8781f1b398dfcb6224d58a0883f1 /doc
parent25c95e722176d876583bddf640144eec32156927 (diff)
downloadpycadf-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
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt3
1 files changed, 3 insertions, 0 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