Commit Graph

7 Commits

Author SHA1 Message Date
Andreas Jaeger ff1203e53a 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: I3b9bcb2bf8e09ddb3dcb8182f4d7ff21c8a07fde
2020-06-04 14:16:03 +02:00
Kristal Dale bb08f17062 Update landing pages for docs 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:38344

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

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note
pages)

Story: 2004737
Task: 28804

Change-Id: I395a15a2cfde2ceaf7f7e203eb48e02a11394af0
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-22 13:33:34 -08:00
Abraham Arce 46d80c8059 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Modify content to:

- Add pointers in the main doc to release notes pages.
- Add search at bottom of relese notes.

Add zuul post jobs:

- publish-stx-releasenotes

Change-Id: Ic795e9afd22838bb5452224267e600afba9de2cf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:32:45 +00:00
Dean Troyer ee9618869d Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready
and fix pep8 issues in the configs

Change-Id: I7574bab4de7db6434ac2ec7fa8477be2fa7970b7
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-11 09:00:49 -05:00
Abraham Arce 84ecd490a6 [Doc] stx.2018.10 Release Summary
Create stx.2018.10 release summary note.

Change-Id: I0383a2e9e3eae89b197af47b1f594ef117af3725
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-27 11:21:02 -05:00
Abraham Arce 64fda558f9 [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.
* Changed to SPDX-License-Identifier: Apache-2.0

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

Story: 2003101
Task: 26732

Change-Id: Ie5eb335cf8da50c26bb29cacc10c817aaf754307
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:27:36 -05:00