Commit Graph

7 Commits

Author SHA1 Message Date
Andreas Jaeger db1f8830ad 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: Ic6fe349728aabb568f8c56194953a3591412dae6
2020-06-04 14:05:42 +02:00
Kristal Dale 5e3f0fdfb7 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
- Add missing section (docs) to bring inline with other pages
- Update project name in link to release notes
- Update project name in config for docs/releasenotes

Story:2007193
Task:38249

Change-Id: I3a336184cadf910bd66ce4d3349917fc530dcbde
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:34:59 -08:00
Kristal Dale 43f5fc1c85 Update config for release notes to include project name
Update conf.py for release notes to include the project
variable, set to the project name. This is so the string
above the left nav renders the project name.

Story: 2004900
Task: 29224

Change-Id: I4fdfd26afa9e2b654d0488d748364e54ca70edc5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-02-05 14:23:41 -08:00
Abraham Arce a29d18f1c6 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Additionally add in zuul post jobs:

- publish-stx-releasenotes

Depends-On: https://review.openstack.org/#/c/611761/
Change-Id: I1483c490192f9a44947e2e9e370efdd3bdf716d9
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:34:07 +00:00
Dean Troyer 4b2560dee0 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I64b705d8f7f5236c0a6cf9a5da347a10eb71fe16
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 09:53:12 -05:00
Abraham Arce 914f002e41 [Doc] stx.2018.10 Release Summary
Create stx.2018.10 release summary note.

Change-Id: I083c3160eeabb635ba7587db995a1c576dabe595
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-27 22:46:50 -05:00
Abraham Arce f795260e03 [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: 26713

Change-Id: Iaadde3d214d16a601d779612ede01d09babd8b43
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:08:20 -05:00