Commit Graph

13 Commits

Author SHA1 Message Date
Hugo Brito e6f666d09f Fix tsconfig/root constraints file in tox.ini
The constraints file used for tsconfig and root was removed.
We need to update the file to use the StarlingX Debian constraints file.

Test Plan:
PASS: Run tox for tsconfig and root dir

Closes-bug: 2055734

Change-Id: I3b2430008a8f6c76a41457b2e4ea01f7b529854c
Signed-off-by: Hugo Brito <hugo.brito@windriver.com>
2024-03-04 22:22:31 +00:00
Igor Soares 3f44e0b9ca Fix Zuul failures due to new Sphinx release
Gate has been broken due to Sphinx 7.2.0 release, thus preventing
reviews from being merged. This commit ensures that the previous Sphinx
version will be used instead.

Change-Id: Iccb0a90b8742826a0c6ac56f930510060bb23463
Signed-off-by: Igor Soares <Igor.PiresSoares@windriver.com>
2023-08-21 13:06:19 -03:00
Al Bailey 43ec9b8119 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

Closes-Bug: #1976377
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: I4d489a7bb8f579c894081bedba8ac3638a7eae1d
2022-05-31 13:56:30 +00:00
Andreas Jaeger e3b1079d21 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: I952b87de1d14b9c83dd0d7df8ab5d2ed0b30c555
2020-06-04 14:13:51 +02:00
Kristal Dale 6d53febf34 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:38336

Change-Id: Ia01582558ab27accb68ccdf00d492f5e79689f04
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:35:28 -08:00
junboli ec8cefa04f Fix the error links for config 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: I8f0d7b87e553b84b285bdeef679ba5e552c0ed54
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 12:49:04 +00:00
Kristal Dale 009bd77d75 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

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

Change-Id: I0bbd0812f4f2132193724feb9b18910389dc85f4
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 16:49:27 -08:00
Abraham Arce 2dbcce8dec [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I82dfaea0f9df11d36d00f7f23453c67923a4a359
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:33:25 +00:00
Dean Troyer 5416d396d9 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: I6286efb94cab686c978b9d3924bcd621250107f6
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-09 19:41:46 -05:00
Dean Troyer 6a82dc05b0 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I538f2f6ceda9b4401308b3daf9722ffe2e64cf11
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-05 16:09:21 -05:00
Abraham Arce 74c22d595c [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: 26515

Change-Id: I7294ee2fec53bce8381f85854fd9c22abe7c5b74
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-21 16:08:09 -05:00
Abraham Arce 2440f88207 [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 if it exists.

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

Story: 2003101
Task: 26514

Change-Id: I7fda1f84d336940dc8851eb053d451981e36bf4d
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-21 16:07:58 -05:00
Abraham Arce 6019a07f29 [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: 26510

Story: 2002813
Task: 26509

Change-Id: I30a92b228540eebd0f991e0c90675bc12d925894
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-21 15:48:33 -05:00