From 8e57c59eb59dd2ec54726909f1789efc81ef41ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Tue, 5 Jan 2021 09:25:33 +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: I737a7d7f6781abb84bd5213d0723bb14a48eb89f
---
 doc/requirements.txt  | 4 ++++
 test-requirements.txt | 5 -----
 tox.ini               | 3 +++
 3 files changed, 7 insertions(+), 5 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 000000000..3a9a6af5c
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,4 @@
+openstackdocstheme>=2.2.1 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+docutils>=0.11 # OSI-Approved Open Source, Public Domain
+reno>=3.1.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index cc5fc0154..58a875425 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -2,17 +2,12 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-openstackdocstheme>=2.2.1 # Apache-2.0
-
 coverage!=4.4,>=4.0 # Apache-2.0
-docutils>=0.11 # OSI-Approved Open Source, Public Domain
 python-subunit>=1.0.0 # Apache-2.0/BSD
-sphinx>=2.0.0,!=2.1.0 # BSD
 oslotest>=3.2.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
 PyYAML>=3.12 # MIT
-reno>=3.1.0 # Apache-2.0
 urllib3>=1.21.1  # MIT
 requests-mock>=1.2.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 7f381c85c..de8d3aad4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -66,6 +66,8 @@ commands =
   coverage report
 
 [testenv:docs]
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+       -r{toxinidir}/doc/requirements.txt
 commands =
   sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html
 
@@ -89,6 +91,7 @@ commands =
     bash -c tools/check_duplicate_jinja_blocks.sh
 
 [testenv:releasenotes]
+deps = {[testenv:docs]deps}
 commands = bash -c tools/releasenotes_tox.sh
 
 [testenv:requirements]