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
- 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>
Added API reference manual to the api-ref/source dir for stx-update.
This represents the converted old-style files to the newer
OpenStack supported RST files.
This change was introduced and abandoned:
https://review.openstack.org/#/c/605278/
Reason was a confussion during the split of the old API into the new
API scheme.
Change-Id: Ic64509c2fd51a659f156e6cbc847e160d4c339e3
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:
- [1] How to document your OpenStack API service
This change was introduced and then reverted due to this abandoned
commit:
https://review.openstack.org/#/c/605278/
Reason was a confussion during the split of old API into the new
API scheme.
[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: Id78d51a67bb155180bfc55908b7cc3ceb503eac7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This is empty and is being removed from the docs.starlingx.io
api-ref landing page. The review to add content here [0] was
abandoned, this is cleaning up the empty directory.
[0] https://review.openstack.org/#/c/605278/
Change-Id: I35a88672e2c8ef0bc37eb46eba37cd3fbd104a08
Signed-off-by: Dean Troyer <dtroyer@gmail.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 the default themes to alabaster
Change-Id: Ied2bb5738cb04c539995850810064b03ca937862
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Andreas Jaeger