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
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Remove install_command from tox.ini, the default is fine
- move basepython into testenv
- use TOX_CONSTRAINTS_FILE instead of obsolete UPPER_CONSTRAINTS_FILE
- update pbr to current versions
Change-Id: Iae3f34e63d5a7d84bcc74716e490bd3b02bcab52
* 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
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Change-Id: I0570d5b3c2f8401566bf2eecf41af2035b44650c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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
The docs CI job is failing on trying to run tox -evenv to run build
sphinx. However this job was not defined anywhere. THis commit adds the
job definition to hopefully unbreak the job. To enable the jobs to work
we also need to install the sphinx deps to build the docs. This was
previously done in the tox.ini but this commit moves it to
test-requirements.txt to ensure that all the tox jobs are able to build
docs.
Change-Id: I5457f3e442fe673a81925a8ed2f36f4eab0639cb
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
style checks can now be run with 'tox'. This does not yet integrate
this to the gate, but it does clean up all the existing code to
work with the currently released bash8 pip.
Done as an easy example to create a pattern for other shell programs.
Change-Id: I5ecf28cfa2551f0cf3502263a379242c8803252c