This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.
Story: 2006070
Task: 35463
Change-Id: Ie5f522d0561d52206eabf400f4a53f67a8997eca
As communicated in ML thread
- http://lists.openstack.org/pipermail/openstack-discuss/2020-June/015499.html
grenade team will only be responsible for maintaining the 'Maintained' stable
branches only not the EM. We will start making the grenade job on EM and oldest
'Maintained' as n-v if they start failing.
This commits document that agreement so that it can be followed consistently.
Change-Id: I615a6b88d39ab1c91fdf57b3393cbbca66833671
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Add configuration for openstackdocstheme 'report a bug'.
Depends-On: https://review.opendev.org/728938
Change-Id: I0938ef80ec161607e7c4b2a4a846f1b32e7614e3
* Remove settings that openstackdocstheme now defaults to.
* Switch completly to openstackdocstheme to be in sync with
other OpenStack projects.
* Use sphinx-build.
* Change tools/generate-grenade-plugins-list.py to use opendev URLs.
Change-Id: Ic6dd19d8695f4d8db6655e7cac7a6eb7736cd4c1
Docs build was broken with:
TypeError: __init__() got an unexpected keyword argument 'handle_io_errors'
Upgrade sphinx requirements to those of a recent decade, and replace
the oslosphinx extension and requirement with openstackdocstheme.
At the same time, split the deps for the docs build out of
test-requirements.txt and put them in docs/requiremenst.txt as the gods
intended.
Change-Id: I6f82b5c37217ca2bdcf85c1ce07293b3d1026370
This commit makes to generate a plugin list for the registry
document and, also fixes a python3 incompatibility and docs warnings
in generate-grenade-plugins-list.sh.
And this commit also removes doc/source/plugin-registry.rst because
it's generated by the script.
Change-Id: I391ca452f2e99e899ded8e4bcb5649a4511a7696
This copies the devstack plugin detection code, to be executed
from a nearly identical periodic proposal job, generating a list
of plugins in the same format.
Change-Id: Ifac7833b03409a4c476b3c9f0f9900987b5ad177
This commit adds basic docs building support to grenade. Previously
we just had rst files in the root of the repo and relied on github
or something else to render them. After this commit we'll support
sphinx built docs.
The next step after this is to add a docs publishing job to infra so
we'll have hosted grenade documentation like other projects.
Change-Id: I505c1d5e250d103b6e0f9da008f44d3ce28df94f
Ghanshyam Mann