Commit Graph

9 Commits

Author SHA1 Message Date
Andreas Jaeger efcfc7a45a 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: I7da2bdaafe86b9eb930202bef3742571daa90e17
2020-06-04 14:18:06 +02:00
Kristal Dale 54ed99eb3c 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:38342

Change-Id: I65d4b92deef90c09f7c1f309bf79e454c570c8a1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:36:06 -08:00
Kristal Dale 6cd39f8226 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)

Story: 2004737
Task: 28803

Change-Id: I11ba3784a5d50953d62f0bc4a08f3f2b308da6b5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-08 15:52:04 -08:00
Scott Rifenbark c59024ac56 Release Notes: Minor wording change.
Change-Id: Ia64fe1396d07103963951644f94d23f6bdf0ab7f
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-10-23 10:11:31 -07:00
Abraham Arce 5b01572a60 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Add zuul check and gate job:

- build-openstack-api-ref

Change-Id: I33252608b94b08b2e70511a76744b82c2d0fc937
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:34:48 +00:00
Dean Troyer f65be03019 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

Depends-On: https://review.openstack.org/#/c/608409/

Change-Id: Ide9a7d5829b41191c9127af75c4320f94d82f428
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 05:16:22 -05:00
Dean Troyer b698d300c1 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I2d5d4456b3f21ea2c27f6e6b519170482f617fb5
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-11 05:16:01 -05:00
Abraham Arce f5d74e6da7 [Doc] stx.2018.10 Release Summary
Create stx.2018.10 release summary note.

Change-Id: Id0260411703bac908570a2f5c8ae9f713b4f1e62
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-27 11:07:43 -05:00
Abraham Arce 09599bb049 [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.

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

Story: 2003101
Task: 26620

Change-Id: Ie0eac726983f8cdfb6bade20a2b5445559a962e0
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 08:17:47 -07:00