Commit Graph

11 Commits

Author SHA1 Message Date
Andreas Jaeger 2366e49be2 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: Idab9f25410d92df8445d3a2ff09fe46ce14cfd9c
2020-06-04 14:39:04 +02:00
Kristal Dale d48327bf95 Update project name in config and links
- Update project name in link to release notes
- Update project name in config for docs/releasenotes

Story:2007193
Task:38351

Change-Id: Ic35002434bd3c3dd67a24d82834b2447d035cf63
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-22 11:31:58 -08:00
Kristal Dale 0011f51e91 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

Change-Id: Id116b27f333e038802a706fadb47484e68f837d8
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-17 14:18:30 -08:00
Kristal Dale 505596f67d Update config
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: 29236

Change-Id: I4b1219c6246ab49279f716fe0d9295e263818dae
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-31 15:21:15 -08:00
Abraham Arce fe064c2fb0 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Change-Id: I173240dd7d1241047769a8dd409567ccc27a0a2c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:38:13 +00:00
Dean Troyer 590847852a Add relnotes publish job
* Add pointers in the main doc to releasenotes pages
* Add publish-stx-releasenotes job
* Add search at bottom of relnotes page to trigger the job

Change-Id: I2102776bf3ec4e7ef0603fe389bf97889be45632
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 15:13:18 -05:00
Zuul 1e4f62430e Merge "[Doc] SPDX License Identifier" 2018-10-11 14:41:35 +00:00
Dean Troyer d57fac0390 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I291bef8384bcbdb6bc419dee0de1b4bcb4e2894f
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-04 17:17:56 -05:00
Abraham Arce cc66a91da2 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: I8be26f68f275ab34b6894286c5aa9cef502c0f92
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 12:48:07 -05:00
Dean Troyer 88ba4d5f22 Add docs, releasenotes jobs
Also:
* Use build-openstack-docs-pti job template for docs
* 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.
* Create a release summary note.
* Remove the unused 'true' tox environment.
* Fix doc/build in .gitignore

Change-Id: Ibe9d298bcc76f023c0500038db55d8384f5ff731
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-05 19:08:28 -05:00
Abraham Arce ed79155570 [Doc] Release Notes Management
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: 24554

Change-Id: I812b92a60599edc28ace84f286200522a706e3cd
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-08-11 04:59:44 -05:00