From fa7e59644d66d4754f849d36ac392cebdb335a70 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Herv=C3=A9=20Beraud?= <hberaud@redhat.com>
Date: Thu, 7 Jan 2021 16:07:40 +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 however it doesn't
produce any doc or releasenotes, but uniformization can't hurt and help
us in the future.

[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: I746d4b743924eefeb606e8516e2f60244b977c92
---
 doc/requirements.txt  | 3 +++
 test-requirements.txt | 5 -----
 tox.ini               | 2 ++
 3 files changed, 5 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..500cb6c
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,3 @@
+sphinx!=1.6.6,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,>=1.6.2;python_version>='3.4' # BSD
+sphinx_rtd_theme
diff --git a/test-requirements.txt b/test-requirements.txt
index a349a26..18d2ecb 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -4,8 +4,3 @@ fixtures>=0.3.14
 python-subunit>=0.0.18
 stestr
 testtools>=0.9.36,!=1.2.0
-
-# docs
-sphinx!=1.6.6,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
-sphinx!=1.6.6,>=1.6.2;python_version>='3.4' # BSD
-sphinx_rtd_theme
diff --git a/tox.ini b/tox.ini
index 02a863a..f9fb916 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,6 +22,8 @@ basepython = python3
 commands = {posargs}
 
 [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:pep8]