From 8d4a5ec633476dc2307a50193a990b34d6a1380e Mon Sep 17 00:00:00 2001
From: Dmitriy Rabotyagov <dmitriy.rabotyagov@cleura.com>
Date: Thu, 17 Aug 2023 16:32:26 +0200
Subject: [PATCH] Define constraints file for docs and renos

Right now we are not using any constraints for docs and releasenotes builds.
This has resulted in docs job failures once Sphinx 7.2.0 has been released.

The patch will ensure that constraints are used an we should not face
simmilar issue again.

TOX_CONSTRAINTS_FILE is updated by Release bot once new branch is created,
so it should always track relevant constraints.

Some extra syntax-related changes can apply, since patch is being passed
through ConfigParser, that does not preserve comments and align indenting.


Change-Id: I6c0e5e73d0c1842432e506eb8fa9e002f3b9a24a
---
 tox.ini | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/tox.ini b/tox.ini
index 1d34c2a..3a1fd81 100644
--- a/tox.ini
+++ b/tox.ini
@@ -30,7 +30,9 @@ setenv =
     WORKING_DIR={toxinidir}
 
 [testenv:docs]
-deps = -r{toxinidir}/doc/requirements.txt
+deps =
+    -r{toxinidir}/doc/requirements.txt
+    -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
 commands =
     bash -c "rm -rf doc/build"
     doc8 doc
@@ -39,21 +41,21 @@ commands =
 [testenv:pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
-  make
+    make
 commands =
-  sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
-  make -C doc/build/pdf
+    sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
+    make -C doc/build/pdf
 
 [doc8]
-# Settings for doc8:
 extensions = .rst
 
 [testenv:releasenotes]
-deps = -r{toxinidir}/doc/requirements.txt
+deps =
+    -r{toxinidir}/doc/requirements.txt
+    -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
 commands =
     sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
 
-# environment used by the -infra templated docs job
 [testenv:venv]
 commands =
     {posargs}
@@ -63,11 +65,7 @@ commands =
     bash -c "{toxinidir}/tests/common/test-pep8.sh"
 
 [flake8]
-# Ignores the following rules due to how ansible modules work in general
-#     F403 'from ansible.module_utils.basic import *' used;
-#          unable to detect undefined names
-#     H303 No wildcard (*) import.
-ignore=F403,H303
+ignore = F403,H303
 
 [testenv:bashate]
 commands =