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/10062https://github.com/sphinx-doc/sphinx/issues/10474
Partial-Bug: #1976377
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: I5fea877955c0d9b875c31f0b64bc8f3bced5c208
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: I4a29839379aaf82893f3f34af17f6134091e7064
- 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:38347
Change-Id: I52a53260042e6924673230486476c394001683ca
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
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: I3591df21e477a7111e4f00c4245d26b71faf06d3
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
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. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note pages)
Change-Id: I4847f655f72c3ce4fe1f0d197b00167e499dd658
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* 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: I809c932377f1346169317bd6ef80421163851c54
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: I5bc676fcb03b81a6a339051675962fcc11089493
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
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.
* Changed to SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 26722
Change-Id: I5643b035a660a257a1e0b9ca2d70e8fe5cb13d3a
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Al Bailey