Add doc/requirements

Removing specific doc requirements from test-requirements.txt and move
them to a dedicated place.

Indeed, we need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].

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.


Change-Id: Ibf838f01d935763ff1e0d19f10340c8ee360784c
This commit is contained in:
Hervé Beraud 2021-01-07 11:52:26 +01:00
parent d6220444fd
commit 8036700154
3 changed files with 4 additions and 2 deletions

doc/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0

View File

@ -6,5 +6,3 @@ bashate>=0.5.1 # Apache-2.0
hacking>=3.0.1,<3.1.0 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0

View File

@ -18,6 +18,8 @@ whitelist_externals = bash
commands = {toxinidir}/tools/
deps = -c{env:TOX_CONSTRAINTS_FILE:}
commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html