Commit Graph

8 Commits

Author SHA1 Message Date
Jeremy Stanley 8e1ff97004 Update tox.ini for compatibility with Tox 4.x
Drop the skipsdist and usedevelop settings, they're not needed in
this project anyway and have different side effects in newer Tox.

Change-Id: I231815a9bb7ee81ec4e9f011d75a704fa471d6dd
2023-01-17 14:35:03 +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
Andreas Jaeger eeee9fddd2 switch documentation job to new PTI
Update .zuul.yaml to use PTI job, update tox.ini to use the common way
to run sphinx, update setup.cfg for handling warnings as errors.

Add new docs target to tox.ini and make it default target, the target is
needed by CI scripts.

Note that ossa does not work with python3, so the docs environment does
not use basepython. This needs a rework of doc/source/_exts/vmt.py.

Change-Id: I7196aab97167d857f0afdfe005d74c7f0f8f1073
2018-11-05 10:25:23 +01:00
Doug Hellmann 335308278a fix tox python3 overrides
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: I5ba6a1e89516ccb4084633d060f70a4f9cc21bdd
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-09-26 18:48:51 -04:00
Tristan Cacqueray 3ddd6ef25c Minors template improvements
If CVE is 'Requested' then it's not used in reporters and mitre reference.
Adds wordwrap to notes and errata text.
Remove a trailing space.

Change-Id: I5c649aea967868ce0726eac9e374f4f4f83d2cb6
2015-01-15 20:22:46 +00: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