From 6e8731e572fb647c50f2d2c6badb1ce05cf465d0 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Sat, 6 Oct 2018 14:23:21 -0500 Subject: [PATCH] Add publish job for docs Also set the theme to alabaster until starlingxdocs is ready Change-Id: I6a113b9fddb64792b5454b3ef0ef866ef9f74fc6 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 44496097..93e7cc8d 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -14,3 +14,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 a3948490..27fd8467 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -38,8 +38,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'] @@ -77,7 +78,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 df3d6942..d4b58a09 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,9 +7,19 @@ StarlingX Bare Metal and Node Management, Hardware Maintenance. :maxdepth: 2 :caption: Contents: +Links +===== +* Source: `stx-metal`_ +* Code Review: `Gerrit`_ +* Bugs: `Storyboard`_ -Indices and tables +.. _stx-metal: https://git.starlingx.io/cgit/stx-metal/ +.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-metal +.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-metal + +Indices and Tables ================== * :ref:`search` +* :ref:`genindex` diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 53db678f..24d172d1 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -103,7 +103,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