4 Commits

Author SHA1 Message Date
Andreas Jaeger
e3b1079d21 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: I952b87de1d14b9c83dd0d7df8ab5d2ed0b30c555
2020-06-04 14:13:51 +02:00
Kristal Dale
6d53febf34 Update landing pages for docs, api-ref, 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:38336

Change-Id: Ia01582558ab27accb68ccdf00d492f5e79689f04
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:35:28 -08:00
Abraham Arce
2dbcce8dec [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I82dfaea0f9df11d36d00f7f23453c67923a4a359
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:33:25 +00:00
Abraham Arce
74c22d595c [Doc] OpenStack API Reference Guide
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:

- [1] How to document your OpenStack API service

[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html

Story: 2002712
Task: 26515

Change-Id: I7294ee2fec53bce8381f85854fd9c22abe7c5b74
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-21 16:08:09 -05:00