From 46d80c8059a815b90da3af506a6f82b9269df20d 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 Modify content to: - Add pointers in the main doc to release notes pages. - Add search at bottom of relese notes. Add zuul post jobs: - publish-stx-releasenotes Change-Id: Ic795e9afd22838bb5452224267e600afba9de2cf Signed-off-by: Abraham Arce --- .zuul.yaml | 1 + doc/requirements.txt | 2 +- doc/source/conf.py | 2 +- doc/source/index.rst | 8 ++++++++ releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 2 ++ 6 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index 2149e93..c936b46 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -15,3 +15,4 @@ post: jobs: - publish-stx-tox + - publish-stx-releasenotes diff --git a/doc/requirements.txt b/doc/requirements.txt index a02a541..3a7529d 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 081c99d..bded6c3 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/doc/source/index.rst b/doc/source/index.rst index 81cfd06..48133c6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,14 @@ StarlingX Distributed Cloud Client :maxdepth: 2 :caption: Contents: +Release Notes +------------- + +.. toctree:: + :maxdepth: 1 + + Release Notes + Links ===== diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index c000d37..d7881d1 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 diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index f4acedd..284609f 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -5,3 +5,5 @@ stx-distcloud-client Release Notes :maxdepth: 2 unreleased + +:ref:`search`