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
Change-Id: Ie5befebdae510e68831f54abe54b076946fd2021
Signed-off-by: Leonardo Fagundes Luz Serrano <Leonardo.FagundesLuzSerrano@windriver.com>
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: Ia5c43bba9a5a75cc70df0084166b9e6492cccd90
- 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:38350
Change-Id: I3c44012bc67136aed1e12c63037c822db7cdc4a6
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: Ife79a7b697d562fac0f09163c036c4216a14f63d
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: I42e5b160336baf8498a83a5414a6e353cc529c5c
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: I3ba4672681bdcc1810e10c534cfa0e49b4d82a2c
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: Idcfe4244f6d43380c8cee87d165ca2786f3e1767
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.
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 26719
Change-Id: If4f8833fb4d3539ba47ce3014d4d3bbae409c278
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Leonardo Fagundes Luz Serrano