With Sphinx>=4 the docs build is failing when processing some
translations due to warnings occurring. Don't treat the warnings as
error for now to unblock other patches. See also the discussion in [0].
[0] https://review.opendev.org/c/openstack/openstackdocstheme/+/802758
Change-Id: Icd44440ddade54b7e963ab652074a0107f4b444b
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
There was a time when doc build warnings were ignored. During this dark
period, several translations were introduced that generated warnings.
These went unnoticed. Then, in a separate repository, the sphinx -W flag
(treat warnings as errors) was switched on. But still, nobody noticed,
because nobody made changes to this repository.
Then came the day when someone did [1][2]. And their patches wouldn't
build. And they were sad.
So a workaround [3] was instated whereby, for this repository,
warnings-as-errors was switched off.
Then the broken translations were fixed [4][5][6]. And there was much
rejoicing.
So now we can reinstate -W, which will cause future borked translations
to break the build, enforcing appropriate discipline therein.
[1] https://review.openstack.org/#/c/633939/
[2] https://review.openstack.org/#/c/634333/
[3] https://review.openstack.org/#/c/633968/
[4] https://review.openstack.org/634545
[5] https://review.openstack.org/634592
[6] https://review.openstack.org/634638
Change-Id: I5e47a9147a59b0bcbaef116d8e4b91da0af806c5
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
Split up doc8 commandline, use separate doc8 section for it to better
visualize what we do. Remove things that are not needed for this repo
since doc8 only checks below doc directory, include also README file for
checking.
Add -d option to sphinx-build so that the doctrees directory does not
get published.
Fix also two occurences of UTF-8 characters in intro.rst, we can use
ASCII everywhere and use a normal '.
Change-Id: Ib81ccba6ad92e2d07ff96d48746696454986d3ed
Use the new PTI job instead of the obsolete one, this
now runs "tox -e docs".
Update docs environment to error on warnings as done before.
Change-Id: I2a6bb786d434e1ef3e7fc9a5c888db708e2a268b
Pep8 was producing warnings about files in the doc/build
directory. These warning are not necessary. This change
adds --ignore-path for those things that do not need to
be verified by pep8/doc8 .
Change-Id: Icb83d5d7e87ea75e3296e33e0e726e2374948f57
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
Dr. Jens Harbott