Commit Graph

5 Commits

Author SHA1 Message Date
Jeremy Stanley 3cdffa08d1 Un-pin PyYAML
The newer default Python interpreter version on Ubuntu 22.04 LTS
doesn't support older PyYAML's use of stdlib collections. It was
pinned to a specific version when first added in 2014 by
I384971732166fbeb123d572d3ccbcde6bad39dfc with no reason given.

Change-Id: I9c18dbd542615f795f063fb6c665f6b6a475e498
2022-12-13 16:34:41 +00:00
Andreas Jaeger d926c5f13d Switch to newer openstackdocstheme version
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.

Disable openstackdocs_auto_name to use 'project' variable as name.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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

Remove also now obsolete sections from setup.cfg and cleanup tox.ini.

Change-Id: I861983389f7dc57d229a2c87e28ff3deb91a4a63
2020-06-03 20:50:01 +02:00
Andreas Jaeger b3b22ebb4e Use python3 for doc building
Update requirements and code for python3, this will not work with
python2 anymore.

Also, update to openstackdocstheme as current OpenStack theme and
configure it.

Some noteworthy changes:
* Remove reload, setting of UTF-8 in vmt.py - this is not needed anymore
  with python3.
* Update requirements of Sphinx to current versions
* The Markup construct does not work with python3 in conf.py, replace
  with simpler string.
* No need to use "pip -U", remove -U option.
* in vmt.py: Strings are unicode in python3, no need to check for it.

Change-Id: I421e3d4a09ff19523b3bd0ca015e31a4bd1e0608
2018-11-05 21:11:58 +01:00
Grant Murphy eb2776f714 Use templates to generate rst documentation
Using Jinja2 to generate ReSTructured text documents via a Sphinx
Extension.

Change-Id: I384971732166fbeb123d572d3ccbcde6bad39dfc
2015-01-12 08:09:38 -08:00
Thierry Carrez 62af610079 Import basic repository structure
Prepare for repository publication by:
- moving all YAML under ossa/
- cargo-culting doc building from openstack/governance
- adding a LICENSE (CC 3.0 BY)

Change-Id: I68354a7b75060ed5012e16048e40ffb61007ff9d
2014-12-01 11:27:31 +01:00