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].
Removed 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.


Change-Id: I23bbefb2549afdb7e54c9b0c245a338cae4e81e9
This commit is contained in:
Hervé Beraud 2021-01-05 11:36:05 +01:00 committed by Pierre Riteau
parent 10ef8b76dd
commit f6b619e8e8
3 changed files with 7 additions and 6 deletions

doc/requirements.txt Normal file
View File

@ -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

View File

@ -7,9 +7,3 @@ hacking>=1.1.0,<3.0.1 # Apache-2.0
# hacking to 3.2.0 or above. hacking 3.2.0 takes
# care of pyflakes version compatibilty.
pyflakes>=2.1.1 # MIT
# docs
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=3.1.0 # Apache-2.0

View File

@ -35,16 +35,20 @@ commands =
coverage xml -o cover/coverage.xml
deps = -c{env:TOX_CONSTRAINTS_FILE:}
commands =
sphinx-build -W -b html doc/source doc/build/html
deps = {[testenv:docs]deps}
whitelist_externals = make
commands =
sphinx-build -b latex doc/source doc/build/pdf
make -C doc/build/pdf
deps = {[testenv:docs]deps}
commands =
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html