This patch enables the sphinx PlantUML extension. As PlantUML is often
used in Tacker documents, authors of specs can re-use diagrams when
they write user guides with small revising.
To build plantUML with a sphinx PlantUML extension:
- Updated conf.py
- Updated requirements
- Added plantuml.jar
To use the sphinx PlantUML extension in Zuul jobs:
- Added bindep [1][2] to install graphviz
- Added pre.yaml to install java [3]
- Updated setup.cfg (this is necessary to place more than two
directories at the project root)
Others:
- Added examples to 2023.2/placeholder.rst and template.rst
[1] https://github.com/openstack/cinder-specs/blob/master/bindep.txt
[2] https://docs.opendev.org/opendev/bindep/latest/readme.html
[3] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-java
Change-Id: I72c2c7887ceba4734b367f7e5bc78921eb0ab0a1
Setuptools v54.1.0 introduces a warning that the use of dash-separated
options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores.
Without this, we see 'UserWarning' messages like the following on new
enough versions of setuptools:
UserWarning: Usage of dash-separated 'description-file' will not be
supported in future versions. Please use the underscore name
'description_file' instead
[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb
Change-Id: Iaa9f6083e0c47f437821d317d00e301e8ffe9bdb
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version, update other needed
requirements
- Remove install_command from tox.ini, the default is fine
- Update tox.ini for python3 support
Change-Id: I0c9f7ae65a8e1c1d7fec77e3958c54324213158b
- Follow new PTI building docs
- Add dir for Stein specs
- Remove skeleton.rst file because the template is enough
- Remove archive specs because they are invalid.
- Remove test_tiltles.py because it is useless (no actuall check
the spec files), instead, enable pep8 and waring-as-error for
.rst files, clear error those files.
- Add placeholder.rst for stein/rocky dir, if not they will
show error when building docs, delete them when it has
approved specs.
Change-Id: I8c387c0a480844b111562a9e77eac6ab26c58bce
+ Changes tacker-specs webpage from oslosphinx to openstackdocstheme.
+ Clean up some example templates and update links.
Change-Id: I639c86a37e93a16171960f7b20a2538e118e4b97
Closes-Bug: #1754960