From d46e9e267dbeecbb81c53d2e011e580354e5a465 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Tue, 5 Jan 2021 11:17:25 +0100
Subject: [PATCH] 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: Ifa46f9f0b7dca27c9e8a305932141da78b85cd50
---
 doc/requirements.txt  | 3 +++
 test-requirements.txt | 3 ---
 tox.ini               | 2 ++
 3 files changed, 5 insertions(+), 3 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..5470738
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,3 @@
+reno>=3.1.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index a64165a..7eb8bcd 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,10 +10,7 @@
 hacking>=3.0.1,<3.1 # Apache-2.0
 coverage>=4.0 # Apache-2.0
 nodeenv>=0.9.4 # BSD
-reno>=3.1.0 # Apache-2.0
 selenium>=2.50.1 # Apache-2.0
-sphinx>=2.0.0,!=2.1.0 # BSD
 testtools>=1.4.0 # MIT
 # This also needs xvfb library installed on your OS
 xvfbwrapper>=0.1.3 #license: MIT
-openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index d314e8a..a4b0a62 100644
--- a/tox.ini
+++ b/tox.ini
@@ -47,6 +47,8 @@ commands =
   npm run {posargs:test}
 
 [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