Commit Graph

6 Commits

Author SHA1 Message Date
Agustin Carranza b9cc232de3 Fix sphinx configuration for tox docs
With sphinx version update, it is raised a warning (treated as
error) with the 'language = None' configuration. The default value is
'language = en' which has the same behavior.

Test plan
PASS: Run tox and check it ends successfully.

Closes-bug: 2033412
Related-Bug: #1976377

Change-Id: Ie003c0a02fcfc6f237ae5b3efb259de6748077ad
Signed-off-by: Agustin Carranza <agustin.carranza@windriver.com>
2023-08-29 17:33:47 -03:00
Andreas Jaeger f555f4a717 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: I0f1672c32d14ce7a096bf8c68741208b6fa2434c
2020-06-04 14:20:25 +02:00
Kristal Dale 6f0ed2e8fd 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:38337

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

- Documentation
- Release Notes
- API Reference

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

Change-Id: I8881381821ca3497f3451c15043e1469d3366a52
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 12:01:18 -05:00
Abraham Arce 352583420d [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: 26693

Story: 2002813
Task: 26694

Change-Id: I603077bc75bfed4b6032c65dfb308a75cfb0aa76
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 15:54:38 -07:00