starlingx/update
Code Issues Proposed changes

[Doc] openstackdocstheme starlingxdocs theme

Browse Source 
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Add zuul check and gate job:

- build-openstack-api-ref

Change-Id: I0d59eaf777bb0f462db4d436c030a785e61798d2
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Abraham Arce 2018-10-18 07:11:56 -05:00 committed by Dean Troyer
parent 54c748803d
commit 5a021f1584
5 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.zuul.yaml
View File

@ -4,12 +4,14 @@
- build-openstack-docs-pti - build-openstack-docs-pti
check: check:
jobs: jobs:
- build-openstack-api-ref
- build-openstack-releasenotes - build-openstack-releasenotes
- openstack-tox-linters - openstack-tox-linters
- openstack-tox-pep8 - openstack-tox-pep8
- stx-updates-pylint - stx-updates-pylint
gate: gate:
jobs: jobs:
- build-openstack-api-ref
- build-openstack-releasenotes - build-openstack-releasenotes
- openstack-tox-linters - openstack-tox-linters
- openstack-tox-pep8 - openstack-tox-pep8

2
api-ref/source/conf.py
View File

@ -20,7 +20,7 @@ extensions = [
'os_api_ref', 'os_api_ref',
] ]
html_theme = 'alabaster' html_theme = 'starlingxdocs'
html_theme_options = { html_theme_options = {
"sidebar_dropdown": "api_ref", "sidebar_dropdown": "api_ref",

2
doc/requirements.txt
View File

@ -1,5 +1,5 @@
sphinx>=1.6.2 sphinx>=1.6.2
openstackdocstheme>=1.19.0 # Apache-2.0 openstackdocstheme>=1.26.0 # Apache-2.0
# Release Notes documentation # Release Notes documentation
reno>=0.1.1 # Apache2 reno>=0.1.1 # Apache2

2
doc/source/conf.py
View File

@ -82,7 +82,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'alabaster' html_theme = 'starlingxdocs'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the

2
releasenotes/source/conf.py
View File

@ -93,7 +93,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'alabaster' html_theme = 'starlingxdocs'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the