From 4b2560dee006710bd67d3e7843ac8cdf0c8d98c8 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Sat, 6 Oct 2018 09:53:12 -0500 Subject: [PATCH] Add publish job for docs Also set the theme to alabaster until starlingxdocs is ready Change-Id: I64b705d8f7f5236c0a6cf9a5da347a10eb71fe16 Signed-off-by: Dean Troyer --- .zuul.yaml | 3 +++ doc/source/conf.py | 7 ++++--- doc/source/index.rst | 12 +++++++++++- releasenotes/source/conf.py | 2 +- 4 files changed, 19 insertions(+), 5 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index 8fb36cf..29a1be4 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -12,3 +12,6 @@ - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 + post: + jobs: + - publish-stx-tox diff --git a/doc/source/conf.py b/doc/source/conf.py index 4f2b125..5f2b3ed 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,8 +42,9 @@ release = u'0.1' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['openstackdocstheme' - ] +extensions = [ + 'openstackdocstheme', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -81,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 = 'openstackdocs' +html_theme = 'alabaster' # 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 1c6033d..e2e0185 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,9 +7,19 @@ StarlingX Client Libraries :maxdepth: 2 :caption: Contents: +Links +===== +* Source: `stx-clients`_ +* Code Review: `Gerrit`_ +* Bugs: `Storyboard`_ -Indices and tables +.. _stx-clients: https://git.starlingx.io/cgit/stx-clients/ +.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-clients +.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-clients + +Indices and Tables ================== * :ref:`search` +* :ref:`genindex` diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 2a77f88..d6b4b40 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 = 'openstackdocs' +html_theme = 'alabaster' # 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