Commit Graph

5 Commits

Author SHA1 Message Date
Andreas Jaeger
6d317a4e68 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: I4a29839379aaf82893f3f34af17f6134091e7064
2020-06-04 14:42:03 +02:00
Kristal Dale
333380daef Update landing pages for docs and release notes:
- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref

Story:2007193
Task:38347

Change-Id: I52a53260042e6924673230486476c394001683ca
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:41:11 -08:00
Abraham Arce
e363a3e1c9 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Change-Id: Ia425328931741459ad76023d89a042576440f1e4
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:39:17 +00:00
Dean Troyer
3b0f1c219a Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I5bc676fcb03b81a6a339051675962fcc11089493
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:47:01 -05:00
Abraham Arce
31405554d1 [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: 26720

Story: 2002813
Task: 26721

Change-Id: I96b3ad56b8de2a7a21008e976f2fedee149c1e22
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:41:22 -05:00