From 5a021f15848050ce94b72ae20f65e3fb39d47b2b 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: I0d59eaf777bb0f462db4d436c030a785e61798d2 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 b04fc6cb..5e846714 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -4,12 +4,14 @@ - build-openstack-docs-pti check: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 - stx-updates-pylint gate: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 2fc6fab7..ec65486c 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -20,7 +20,7 @@ extensions = [ 'os_api_ref', ] -html_theme = 'alabaster' +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 5b506143..3406fa74 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 a312ed61..28c62f24 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