From 286deaf2aa5a5249c5ddc1a034e80fa2358edfd2 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Fri, 12 Oct 2018 15:18:15 -0500 Subject: [PATCH] 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 the default themes to alabaster Change-Id: Ied2bb5738cb04c539995850810064b03ca937862 Signed-off-by: Dean Troyer --- .zuul.yaml | 2 ++ api-ref/source/conf.py | 2 +- api-ref/source/index.rst | 5 +++++ doc/source/index.rst | 16 ++++++++++++++++ releasenotes/source/index.rst | 6 ++++++ 5 files changed, 30 insertions(+), 1 deletion(-) diff --git a/.zuul.yaml b/.zuul.yaml index 76198d6b..b04fc6cb 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -16,7 +16,9 @@ - stx-updates-pylint post: jobs: + - publish-stx-api-ref - publish-stx-tox + - publish-stx-releasenotes - job: name: stx-updates-pylint diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index a40bab8c..2fc6fab7 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 = 'alabaster' html_theme_options = { "sidebar_dropdown": "api_ref", diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 435e2c8c..3eb6f3b4 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -6,3 +6,8 @@ StarlingX Installation/Update/Patching/Backup/Restore .. toctree:: :maxdepth: 2 + +Search +------ + +:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index b347813a..d7646f2a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,22 @@ StarlingX Installation/Update/Patching/Backup/Restore :maxdepth: 2 :caption: Contents: +Release Notes +------------- + +.. toctree:: + :maxdepth: 1 + + Release Notes + +API Reference +------------- + +.. toctree:: + :maxdepth: 1 + + API Reference + Links ===== diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 1719be11..7e2c42cc 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,3 +1,4 @@ +======================== stx-update Release Notes ======================== @@ -5,3 +6,8 @@ stx-update Release Notes :maxdepth: 2 unreleased + +Search +------ + +:ref:`search`