Commit Graph

4 Commits

Author SHA1 Message Date
Andreas Jaeger db1f8830ad Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these 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_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: Ic6fe349728aabb568f8c56194953a3591412dae6
2020-06-04 14:05:42 +02:00
Abraham Arce a29d18f1c6 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Additionally add in zuul post jobs:

- publish-stx-releasenotes

Depends-On: https://review.openstack.org/#/c/611761/
Change-Id: I1483c490192f9a44947e2e9e370efdd3bdf716d9
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:34:07 +00:00
Abraham Arce f795260e03 [Doc] Release Notes Management
Baseline changes to comply with Release Notes Management
based in Reno [0]:

* Use build-openstack-releasenotes job for release notes
  (We can't use the OpenStack releasenotes template as it includes
  publish jobs, stx needs its own)
* Add newnote tox environment as convenience for creating new release
  notes, re-using the releasenotes venv.
* Changed to SPDX-License-Identifier: Apache-2.0

[0] https://docs.openstack.org/reno/latest/

Story: 2003101
Task: 26713

Change-Id: Iaadde3d214d16a601d779612ede01d09babd8b43
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:08:20 -05:00
Abraham Arce 1185b5fdda [Doc] Building docs following Docs Contrib Guide
Baseline changes to comply with OpenStack Documentation
Contributor Guide [0] starting with the following sections:

- Project guide setup
  - [1] sphinx-quickstart
  - [2] doc/source/ layout
- Building documentation
  - [3] tox -e docs
- Using documentation tools
  - [4] openstackdocstheme
- Use build-openstack-docs-pti job template for docs
- Adding SPDX-License-Identifier: Apache-2.0

[0] https://docs.openstack.org/doc-contrib-guide
[1] http://www.sphinx-doc.org/en/master/usage/quickstart.html
[2] https://docs.openstack.org/doc-contrib-guide/project-guides.html
[3] https://docs.openstack.org/doc-contrib-guide/docs-builds.html
[4] https://docs.openstack.org/openstackdocstheme/

Story: 2002708
Task: 26712

Story: 2002813
Task: 26711

Change-Id: I7aad7497b8e0314ef10f59ecf4b863220b543bf8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:07:16 -05:00