From 19b2e15cee782ae217b7fd11c2712ccd653ae91b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Tue, 5 Jan 2021 11:43:09 +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: Iddc6f1d90f416b8938a712ac0b04aec807f391a9
---
 doc/requirements.txt  | 3 +++
 test-requirements.txt | 3 ---
 tox.ini               | 3 +++
 3 files changed, 6 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..1489bce
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,3 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index d82a2b7..032f304 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -4,9 +4,6 @@
 
 coverage>=3.6 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx>=2.0.0,!=2.1.0 # BSD
-openstackdocstheme>=2.2.1 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
-reno>=3.1.0 # Apache-2.0
 betamax>=0.7.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index dabf696..9c25b9a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -32,12 +32,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 -d doc/build/doctrees doc/source doc/build/html
 
 [testenv:debug]
 commands = oslo_debug_helper {posargs}
 
 [testenv:releasenotes]
+deps = {[testenv:docs]deps}
 commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [flake8]