From cdcdd5ebb3a737053671a2feeb03b5f32717b8a9 Mon Sep 17 00:00:00 2001 From: Abraham Arce Date: Thu, 18 Oct 2018 07:11:56 -0500 Subject: [PATCH] [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 --- .zuul.yaml | 2 ++ api-ref/source/conf.py | 2 +- doc/requirements.txt | 2 +- doc/source/conf.py | 2 +- releasenotes/source/conf.py | 2 +- 5 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index 396a8bc4..1f907c2e 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -4,6 +4,7 @@ - build-openstack-docs-pti check: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - nfv-tox-pep8 @@ -13,6 +14,7 @@ - nova-api-proxy-tox-pylint gate: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - nfv-tox-pep8 diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index a11f76df..6c668765 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -20,7 +20,7 @@ extensions = [ 'os_api_ref', ] -html_theme = 'openstackdocs' +html_theme = 'starlingxdocs' html_theme_options = { "sidebar_dropdown": "api_ref", diff --git a/doc/requirements.txt b/doc/requirements.txt index 0cbe78dc..d197d454 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ sphinx>=1.6.2 -openstackdocstheme>=1.19.0 # Apache-2.0 +openstackdocstheme>=1.26.0 # Apache-2.0 # Release Notes documentation reno>=0.1.1 # Apache2 diff --git a/doc/source/conf.py b/doc/source/conf.py index 091ed23d..04c494dd 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -82,7 +82,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 2ed452d5..14e9c916 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -93,7 +93,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the