Commit Graph

11 Commits

Author SHA1 Message Date
Jessica Castelino bd32299149 Fix: openstack-tox-docs job is broken with Sphinx >= 5.0.0
This commit aims to fix the broken zuul job for this repo.

Change-Id: Ic3a4703506ff53d12acf20ef7589809363ec465d
Signed-off-by: Jessica Castelino <jessica.castelino@windriver.com>
Closes-Bug: 2033671
2023-08-31 17:01:12 +00:00
Andreas Jaeger 6abcfe6977 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: Idcf44f0980a298bd4d63e10c178b72372a449839
2020-06-04 14:40:40 +02:00
Kristal Dale 27eb673b1c 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:38341

Change-Id: I4369fef2a401810ff9cc9a443a3f0572fc327174
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:40:36 -08:00
junboli 1a2147dcdd Fix the error links for starlingx update 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: I282ff4b8a3649490a22db5eca972d40e2cc29452
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 09:35:32 -04:00
Kristal Dale 626f1094ad 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)

releasenotes index.rst:
1. Remove search (make consistent with other openstack release note
pages)

Story: 2004737
Task: 29273

Change-Id: Iff659b42ab14ef5726869d9c9aa69b7c58a756fd
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-02-27 14:22:45 +00:00
Abraham Arce 5a021f1584 [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: I0d59eaf777bb0f462db4d436c030a785e61798d2
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:38:52 +00:00
Dean Troyer 286deaf2aa 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 the default themes to alabaster

Change-Id: Ied2bb5738cb04c539995850810064b03ca937862
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-15 10:36:09 -05:00
Dean Troyer e489326a40 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I5cc9b7203c5a28057783315da100b3caabf67e19
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:42:40 -05:00
Abraham Arce 364d9512a9 [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: 26659

Change-Id: I873f6437d661b80248c39bfce2c1aefece78cca4
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 15:01:49 -07:00
Abraham Arce 57e9e71cb6 [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.
* Remove the unused 'true' tox environment.

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

Story: 2003101
Task: 26658

Change-Id: I0bce008d3c26859ba7ca72aeec664ed417e22ea1
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 15:01:30 -07:00
Abraham Arce 1799425d3d [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

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

Story: 2002813
Task: 26657

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