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 could meet the conditions leading to the bug, and
uniformization can't hurt. These changes will reduce the likelihood to face
pip resolver incompatibilities by splitting requirements.
[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-
Change-Id: I75450f05993a5e1fbebe647ffaab440a9a63bf95
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_version to not auto-version the documents.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I5ff3f372c12db0efeb26737b31006e88ddc238a0
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7
Change-Id: I5abf45901ae579b1c9b359d90dc97868288dcca5
openstackdocstheme 1.28.0 includes a script to build English and
translated documents together, use this for building docs.
Require the new openstackdocstheme version.
Change-Id: If4102ec42ee7f58cff5da46ee326833471520412
Use doc8 for linting of documents to avoid common RST problems.
Fix all problems found (overlong lines).
Update tox.ini:
* Update envlist to show actual used targets
* Use docs command that is run by Zuul scripts
* Remove -U from pip, it can break installations and is not needed here.
Change-Id: Id298af73f7d881352005ddc1c0ea5282b2e5e8e8
Add test-requirements.txt including files needed for docs build.
splitting this up will help with our CI infrastructure.
Change-Id: I0ee2bb1527328eac5d2b4a53b4335b42272cd56a
Hervé Beraud