Commit Graph

13 Commits

Author SHA1 Message Date
Luan Nunes Utimura 4454fad3a8 Fix tox-docs failing sphinx
A new version of sphinx was released May 29 2022
which requires a language setting in config otherwise
a warning (treated as error) causes the sphinx operation
to fail.

Updated the sphinx config file to correct the issue.

The sphinx behavioural change is mentioned here:
https://github.com/sphinx-doc/sphinx/issues/10062
https://github.com/sphinx-doc/sphinx/issues/10474

Partial-Bug: 1976377
Partial-Bug: 2033431

Change-Id: I089f9afe7e75b5ceabe3bf05d14ffd76e33ac3ab
Signed-off-by: Luan Nunes Utimura <LuanNunes.Utimura@windriver.com>
2023-08-30 09:25:39 -03:00
Andreas Jaeger 2366e49be2 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: Idab9f25410d92df8445d3a2ff09fe46ce14cfd9c
2020-06-04 14:39:04 +02:00
Kristal Dale d48327bf95 Update project name in config and links
- Update project name in link to release notes
- Update project name in config for docs/releasenotes

Story:2007193
Task:38351

Change-Id: Ic35002434bd3c3dd67a24d82834b2447d035cf63
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-22 11:31:58 -08:00
Kristal Dale 0011f51e91 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

Change-Id: Id116b27f333e038802a706fadb47484e68f837d8
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-17 14:18:30 -08:00
Hang Li c48f4b1156 Fix the error links for tools doc
The link to the git code library in tools document is error,so redirect
it to the correct link.

Change-Id: I0da979739b31a0acffa0f0e21f429e458a26010b
Partial-Bug: #1835207
2019-07-03 21:03:49 +08:00
hutianhao 6e7acf6c69 Update links for opendev to find "starlingx/tools" project
Can only find "openstack/stx-tools" project through current link.
Update it to make sure of finding "starlingx/tools" project.

Story: 2005525
Task: 30649

Change-Id: I5a2900d7aee52032220a42f04e979dc078a120ba
Signed-off-by: hutianhao <hu.tianhao@99cloud.net>
2019-04-28 03:44:14 +00:00
Abraham Arce fe064c2fb0 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Change-Id: I173240dd7d1241047769a8dd409567ccc27a0a2c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:38:13 +00:00
Dean Troyer 590847852a Add relnotes publish job
* Add pointers in the main doc to releasenotes pages
* Add publish-stx-releasenotes job
* Add search at bottom of relnotes page to trigger the job

Change-Id: I2102776bf3ec4e7ef0603fe389bf97889be45632
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 15:13:18 -05:00
Zuul 1e4f62430e Merge "[Doc] SPDX License Identifier" 2018-10-11 14:41:35 +00:00
Dean Troyer d57fac0390 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I291bef8384bcbdb6bc419dee0de1b4bcb4e2894f
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-04 17:17:56 -05:00
Abraham Arce cc66a91da2 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: I8be26f68f275ab34b6894286c5aa9cef502c0f92
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 12:48:07 -05:00
Abraham Arce ed79155570 [Doc] Release Notes Management
Baseline changes to comply with Release Notes Management
based in Reno [0] a release notes manager.

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

Story: 2003101
Task: 24554

Change-Id: I812b92a60599edc28ace84f286200522a706e3cd
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-08-11 04:59:44 -05:00
Abraham Arce ea97b45e8e [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

[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: 24529

Story: 2002813
Task: 24530

Change-Id: Id9b49e84c79523df2ad6bca183f3407ef84d0f1a
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-08-11 03:21:33 -05:00