From 45df91ada8276911c3d5a2f0002cd365a71228ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Thu, 7 Jan 2021 16:44:41 +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: Iac7d5ec69724206453c5fc74cbd61efde9b9a1ee
---
 doc/requirements.txt  | 3 +++
 test-requirements.txt | 4 ----
 tox.ini               | 4 ++++
 3 files changed, 7 insertions(+), 4 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..f41f72e
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,3 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 2c1f0e2..da16c0a 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -11,8 +11,4 @@ stestr>=1.0.0
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
 
-# documentation
 doc8>=0.8.1 # Apache-2.0
-sphinx>=2.0.0,!=2.1.0 # BSD
-reno>=3.1.0 # Apache-2.0
-openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index e9d5c40..f89529c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -58,18 +58,22 @@ usedevelop = False
 commands = bandit -r monascaclient -n5 -x {env:OS_TEST_PATH}
 
 [testenv:docs]
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+       -r{toxinidir}/doc/requirements.txt
 description = Builds full monascaclient documentation
 commands =
   {[testenv:devdocs]commands}
   {[testenv:releasenotes]commands}
 
 [testenv:devdocs]
+deps = {[testenv:docs]deps}
 description = Builds developer documentation
 commands =
   rm -rf {toxinidir}/doc/build {toxinidir}/doc/source/contributor/api
   sphinx-build -a -W -b html doc/source doc/build/html
 
 [testenv:releasenotes]
+deps = {[testenv:docs]deps}
 description = Called from CI script to test and publish the Release Notes
 commands =
   rm -rf releasenotes/build