Commit Graph

9 Commits

Author SHA1 Message Date
Andreas Jaeger 740160103e 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: Id78ccc70601800cb3843029f8c90350ef6571a5f
2020-06-04 14:34:31 +02:00
Kristal Dale 5c13295994 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:38346

Change-Id: I15af375869bb03120fed052ecc5ce070a5581125
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:39:36 -08:00
Kristal Dale a6732cbe47 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: 29231

Change-Id: Ibb4bea0f5559285a47693833e9ebb2e9290470f5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-30 16:52:50 -08:00
Kristal Dale 37240fa085 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

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

Change-Id: Ia12c5b865f3e4c973a7f403bbf787e7c91bf34a3
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 17:10:05 -08:00
Abraham Arce cdcdd5ebb3 [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: If47613fb6afa4e25b62360a4e3441a93296f4570
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:37 +00:00
Dean Troyer bd7bd5cac1 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

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

Change-Id: Iccf80cf54075925752a3c3773ba7ccba0c47aed3
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:34:47 -05:00
Dean Troyer 2f4e35734c [Doc] stx.2018.10 Release Summary
Create stx.2018.10 release summary note

Change-Id: I0b3cb0e230fd8c3303ca3dbe20a43ad92354e05b
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-28 06:21:30 -05:00
Abraham Arce 9de7e2d16e [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.
* Change to SPDX-License-Identifier: Apache-2.0

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

Story: 2003101
Task: 26667

Change-Id: I33b3083a952faf36168faec4255bec0f25edf9ca
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:01:18 -07:00