Commit Graph

11 Commits

Author SHA1 Message Date
Heitor Matsui c819a65690 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.

Updating a file header to trigger zuul.
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

Note: The bug referenced below is for the config repo,
      but it affects multiple StarlingX repositories.

Closes-Bug: 1976377
Change-Id: I7bb7886f27ce6190f8e23270efc1aadb7364fc90
Signed-off-by: Heitor Matsui <HeitorVieira.Matsui@windriver.com>
2022-06-03 15:20:56 -03:00
Andreas Jaeger 740160103e 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: Id78ccc70601800cb3843029f8c90350ef6571a5f
2020-06-04 14:34:31 +02:00
Kristal Dale 5c13295994 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:38346

Change-Id: I15af375869bb03120fed052ecc5ce070a5581125
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:39:36 -08:00
junboli d223c2ceda Fix the error links for nfv-vim 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: I1ab75cb43ee80d356993162013f9947dff7535fe
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 12:50:02 +00:00
Kristal Dale 37240fa085 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)

Change-Id: Ia12c5b865f3e4c973a7f403bbf787e7c91bf34a3
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 17:10:05 -08:00
Abraham Arce cdcdd5ebb3 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Add zuul check and gate job:

- build-openstack-api-ref

Change-Id: If47613fb6afa4e25b62360a4e3441a93296f4570
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:37 +00:00
Dean Troyer bd7bd5cac1 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: If82fe40b570c43c4ac7b25e5bff5d3d72484677f
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:32:41 -05:00
Dean Troyer c89589d31c Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: Iccf80cf54075925752a3c3773ba7ccba0c47aed3
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:34:47 -05:00
Abraham Arce 86dca67786 [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
- Add SPDX-License-Identifier: Apache-2.0

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

Story: 2002712
Task: 26671

Change-Id: Ia16194f531328f2e936b296a489b936b384addb5
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:01:33 -07:00
Abraham Arce 9de7e2d16e [Doc] Release Notes Management
Baseline changes to comply with Release Notes Management
based in Reno [0]:

* Use build-openstack-releasenotes job for release notes
  (We can't use the OpenStack releasenotes template as it includes
  publish jobs, stx needs its own)
* Add newnote tox environment as convenience for creating new release
  notes, re-using the releasenotes venv.
* Change to SPDX-License-Identifier: Apache-2.0

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

Story: 2003101
Task: 26667

Change-Id: I33b3083a952faf36168faec4255bec0f25edf9ca
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:01:18 -07:00
Abraham Arce f71ded2eba [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
- Change to 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: 26661

Story: 2002813
Task: 26662

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