From 6c93f13c54bb4f0bf82fb77b1048977a1c183f23 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Thu, 7 Jan 2021 16:40:00 +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].
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: Ie4cc84c7159f4b59be52439ef6e4c5e60474866d
---
 doc/requirements.txt  | 3 +++
 requirements.txt      | 2 +-
 test-requirements.txt | 4 ----
 tox.ini               | 3 +++
 4 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 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/requirements.txt b/requirements.txt
index f40b1ba..ebd9838 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -12,7 +12,7 @@ oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0
 oslo.utils>=3.33.0 # Apache-2.0
 os-client-config>=1.28.0 # Apache-2.0
 osc-lib>=1.14.0 # Apache-2.0
-PrettyTable<0.8,>=0.7.1 # BSD
+PrettyTable>=0.7.1 # BSD
 cryptography>=2.7 # BSD/Apache-2.0
 decorator>=3.4.0 # BSD
 openstacksdk>=0.42.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index ebe8b92..ba39f5c 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,11 +6,7 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0
 
 coverage>=4.0,!=4.4 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx>=2.0.0,!=2.1.0 # BSD
 oslotest>=3.2.0 # Apache-2.0
 stestr>=2.2.0 # Apache-2.0
 testtools>=2.4.0 # MIT
-openstackdocstheme>=2.2.1 # Apache-2.0
 requests-mock>=0.6.0  # Apache-2.0
-# releasenotes
-reno>=3.1.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 511b3d3..9ca7d60 100644
--- a/tox.ini
+++ b/tox.ini
@@ -36,9 +36,12 @@ 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 doc/source doc/build/html
 
 [testenv:releasenotes]
+deps = {[testenv:docs]deps}
 commands =
   sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html