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: I5c5c501e23744aa0dbaf4280ed5abcd27442f20f
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: Iab15b05918b73ce9ba2ff0b479fdb8a0631fad42
- 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:38348
Change-Id: I4840bfb9c17128e1883e36b8292ce325045b618a
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: Ib8ec375c3b7b144a5d46187bf2f2aa0ab81b5e82
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)
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)
Story: 2004737
Task: 28801
Change-Id: I83d023c57881e03639ff6bb85b256e53f4205817
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* 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: I0791ab622ed187d8bdf93e5b848fa70a0d3e6c2c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: Ie4e031c536836c558c26c8c87b09f3e04b207f83
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Baseline changes to comply with Release Notes Management
based in Reno [0] a release notes manager.
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 25748
Change-Id: I7d7fdfe38d6a22c0bb8195e9bc82c2df759d06c7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Al Bailey