From 6571d0ed4d8209328d29fd935e7e0eba15266c78 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Sat, 6 Oct 2018 10:12:56 -0500 Subject: [PATCH] Add publish job for docs Also set the theme to alabaster until starlingxdocs is ready and fix pep8 issues in the configs Change-Id: I7574bab4de7db6434ac2ec7fa8477be2fa7970b7 Signed-off-by: Dean Troyer --- .zuul.yaml | 3 +++ doc/source/conf.py | 7 ++++--- doc/source/index.rst | 12 +++++++++++- releasenotes/source/conf.py | 33 ++++++++++++++++++++++++--------- 4 files changed, 42 insertions(+), 13 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index cbbcaf3..2149e93 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -12,3 +12,6 @@ jobs: - build-openstack-releasenotes - openstack-tox-linters + post: + jobs: + - publish-stx-tox diff --git a/doc/source/conf.py b/doc/source/conf.py index 9a24fc9..081c99d 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 0a45cb6..81cfd06 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,9 +7,19 @@ StarlingX Distributed Cloud Client :maxdepth: 2 :caption: Contents: +Links +===== +* Source: `stx-distcloud-client`_ +* Code Review: `Gerrit`_ +* Bugs: `Storyboard`_ -Indices and tables +.. _stx-distcloud-client: https://git.starlingx.io/cgit/stx-distcloud-client/ +.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud-client +.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud-client + +Indices and Tables ================== * :ref:`search` +* :ref:`genindex` diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f7eaec9..c000d37 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 @@ -191,8 +191,13 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'stx-distcloud-clientreleasenotes.tex', u'stx-distcloud-client Release Notes', - u'StarlingX', 'manual'), + ( + 'index', + 'stx-distcloud-clientreleasenotes.tex', + u'stx-distcloud-client Release Notes', + u'StarlingX', + 'manual', + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -221,8 +226,13 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'stx-distcloud-clientreleasenotes', u'stx-distcloud-client Release Notes', - [u'StarlingX'], 1) + ( + 'index', + 'stx-distcloud-clientreleasenotes', + u'stx-distcloud-client Release Notes', + [u'StarlingX'], + 1, + ) ] # If true, show URL addresses after external links. @@ -235,10 +245,15 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'stx-distcloud-clientReleaseNotes', u'stx-distcloud-client Release Notes', - u'StarlingX', 'stx-distcloud-clientreleasenotes', - 'StarlingX Distributed Cloud Client', - 'Miscellaneous'), + ( + 'index', + 'stx-distcloud-clientReleaseNotes', + u'stx-distcloud-client Release Notes', + u'StarlingX', + 'stx-distcloud-clientreleasenotes', + 'StarlingX Distributed Cloud Client', + 'Miscellaneous', + ), ] # Documents to append as an appendix to all manuals.