History

Andreas Jaeger e43daab321 Update to hieroglyph 2.0 hieroglyph 2.0 works with python 3 and Sphinx 2, update to it. Update some other requirements as well. Cleanup tox.ini a bit. Switch to openstackdocstheme 2.2.1 version. Using this versions 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. 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: Ib8ba3e3f514688d06a07598e7d6ceffa79f26220	2020-06-27 20:22:30 +02:00
..
source	Update to hieroglyph 2.0	2020-06-27 20:22:30 +02:00
README.md	Disable publishing of training-guides folder	2018-01-22 18:43:00 +01:00

Andreas Jaeger e43daab321 Update to hieroglyph 2.0

hieroglyph 2.0 works with python 3 and Sphinx 2, update to it.
Update some other requirements as well.

Cleanup tox.ini a bit.

Switch to openstackdocstheme 2.2.1 version. Using
this versions 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.

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: Ib8ba3e3f514688d06a07598e7d6ceffa79f26220

2020-06-27 20:22:30 +02:00

source

Update to hieroglyph 2.0

2020-06-27 20:22:30 +02:00

README.md

Disable publishing of training-guides folder

2018-01-22 18:43:00 +01:00

README.md

Introduction

The subfolders contain the RST files related to the Training Guides.
Please refer the following link to get more information about this project https://launchpad.net/openstack-training-guides
Please follow the following wiki to get more information about development process of Training Guides. This should provide enough information to start contributing to training guides https://wiki.openstack.org/wiki/Training-guides
Training Guides is typically divided into four guides
1. Associate Training Guide
2. Operator Training Guide
3. Developer Training Guide
4. Architect Training Guide
Please follow the following wiki to get more information about development process of Training Guides. This should provide enough information to start contributing to training guides https://wiki.openstack.org/wiki/Training-guides
This document is not published at docs.openstack.org anymore since it's outdated.

Structure of this folder

To get better idea of the design of this folder follow this blueprint https://blueprints.launchpad.net/openstack-training-guides/+spec/separate-folders-for-books
Typically book wise folders are created, read the following for more description:
1. associate-guide: This folder contains RST files related to Associate Training Guide.
2. common: This folder contains common files used by multiple training guides.
3. figures: This folder contains images used by all the training guides.
4. _static: This folder contains theming (CSS) for generating the HTML slides.