6 Commits

Author SHA1 Message Date
Gage Hugo
6ea15a7f9d Add reno job to Openstack-Helm
With OSH now publishing charts regularly with each change, there
needs to be a way to track these changes in order to track the
changes between chart versions.

This proposed change adds in a reno check job to publish notes
based from the changes to each chart by version as a way to
track and document all the changes that get made to OSH
and published to tarballs.o.o.

Change-Id: Iff8681c697957e4711754fc20b07fa6b728eb584
2021-01-20 21:47:35 +00:00
Andreas Jaeger
c0ce62f181 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_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.

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

Change-Id: I46021aa93e28242d0f7dc9d80f598538247a6df5
2020-05-31 20:25:52 +02:00
Andreas Jaeger
34a7533b64 Cleanup py27 support and docs
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine

Change-Id: I785318b3090d7117d74d165ba3236dc239cf9ea1
2020-04-11 15:35:01 +02:00
jacky06
4fd741d6bf Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Remove unncessary "=="

Change-Id: I3451c44a30a2e3d4bb58d2ac512e69da0781e961
2019-06-19 17:52:24 +08:00
Andreas Jaeger
1d5dfa2468 Update docs building
The repo used both openstackdocstheme and oslosphinx in requirements but
then configured openstackdocstheme, remove oslosphinx everywhere.

Instead of using sphinx-build, use  docstheme-build-translated.sh to
build English and translated documents.

Update doc/source/conf.py for newer openstackdocstheme and require
a new enough version.

Remove module index - it does not exist, this is not a python repo where
autodoc works.

Remove sphinx-quickstart generated output from index.rst, it's not
needed anymore.

Change-Id: Ib3f09128226f0bcc78384b1ee2da811d62a5b59d
2019-01-05 09:22:36 +00:00
Tin Lam
e6991e1914 Update docs building infra
This patch set migrates some of the file structure in compliance with
the Project Testing Interface (PTI) [0] for doc build in OpenStack-Infra.
See [1] for more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I5995ffd3a6821fd629e00351728c27a045a7c076
Signed-off-by: Tin Lam <tin@irrational.io>
2017-12-29 00:07:26 -06:00