Commit Graph

13 Commits

Author SHA1 Message Date
John Kung 7a1fb6333c 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: I882faa7ce199d8817598980b9dc5090b4e1af57d
Signed-off-by: John Kung <john.kung@windriver.com>
2023-08-29 16:50:22 -04:00
Andreas Jaeger 0ea80db1ea 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: I04a417a96daffaa5bb6570130545bc66527896d6
2020-06-04 14:32:46 +02:00
Kristal Dale d75d427c11 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

patch 5: Update to use 'Metal' instead of 'Bare Metal' per comments

Story:2007193
Task:38340

Change-Id: I22aa2f15850d4b5ecf01fd78c015b772b87a4932
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-02-07 12:24:12 -08:00
junboli 1ff0d050cc Fix the error links for metal docs
The storyboard and gerrit doc link are error, and git library
redirect to the correct one, this change is to correct all them.

Change-Id: I3adf7b17417324a155c799233f7721f52d8daf0b
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 09:20:25 -04:00
Kristal Dale 3522ead301 Clean up and standardize landing pages
doc index.rst:
1. Update intro sentence to read as a complete sentence
2. Remove unused toctree
3. Correct heading levels (impacting side nav and correct rendering
of content)
4. Remove "Indices and Tables" section: genindex page not used,
search searches only index (not useful here)

api-ref index.rst:
1. Update intro sentence to read as a complete sentence
2. Update text around search link for consistency (move to
follow intro)
3. Add heading before toctree for consistency with other pages

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release
note pages)

Story: 2004737
Task: 28805

Change-Id: I388cc5d69db56e6e94bf034ece2478933c9d9c1e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-09 09:34:38 -08:00
Abraham Arce a526093ba8 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I5a53eecaf97e835e85ea4d5a7fae2bc3ca3d45a8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:08 +00:00
Dean Troyer 5558276784 Add api-ref and relnotes publish jobs
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref and publish-stx-releasenotes jobs
* Add search at bottom of api-ref and relnotes pages to trigger the jobs

Change-Id: Ib41f10ce72eb283d4edbeb1ecc0543403295d7bf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:21:53 -05:00
Zuul cddb485837 Merge "Add publish job for docs" 2018-10-10 13:21:00 +00:00
Dean Troyer 6e8731e572 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I6a113b9fddb64792b5454b3ef0ef866ef9f74fc6
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:23:21 -05:00
Abraham Arce d948fdc228 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: Ie98277f4b8fca7084ff8d3f9622ced048a5d5f9c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 09:39:07 -05:00
Abraham Arce 0162fa2526 [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: 24451

Change-Id: I91f7640583081c83d3d43786e979ccfb5bee0490
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-05 19:59:26 -05:00
Abraham Arce 61abc3aafc [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: 25744

Change-Id: Ib52641346d5a788df53a2bab97c98f2e1de0b170
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-05 19:59:26 -05:00
Abraham Arce 451bad46e9 [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: 24449

Story: 2002813
Task: 24450

Change-Id: I961c7c90c51248926d11b2a2a89c0231f58f7fd0
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-05 19:59:26 -05:00