From b003280698868b43cc0b6fc31db8278d1c4c1c57 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Tue, 2 Oct 2018 13:33:26 -0500 Subject: [PATCH] Add the publish job We have the AFS volume and now a publish job, let's see if we can get from here to there. Include a docs change to ensure the jobs actually run. the web server is near, pending certificate installation. Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30 Signed-off-by: Dean Troyer --- .zuul.yaml | 3 +++ doc/source/conf.py | 14 ++++++++++++++ doc/source/index.rst | 8 ++++++++ 3 files changed, 25 insertions(+) diff --git a/.zuul.yaml b/.zuul.yaml index 2809a7bbb..943bedd53 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -10,3 +10,6 @@ jobs: - build-openstack-api-ref - openstack-tox-linters + post: + jobs: + - publish-stx-docs diff --git a/doc/source/conf.py b/doc/source/conf.py index e6b2325b5..0b542c520 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -6,6 +6,8 @@ # full list see the documentation: # http://www.sphinx-doc.org/en/master/config +import pbr.version + # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, @@ -28,6 +30,17 @@ version = '' # The full version, including alpha/beta/rc tags release = '' +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +version_info = pbr.version.VersionInfo('python-openstackclient') +# +# The short X.Y version. +version = version_info.version_string() +# The full version, including alpha/beta/rc tags. +release = version_info.release_string() + # -- General configuration --------------------------------------------------- @@ -39,6 +52,7 @@ release = '' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/index.rst b/doc/source/index.rst index d29595377..43f3db004 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,6 +33,14 @@ Specs Release Notes +Contributing +============ + +StarlingX utilized tooling and CI/CD environments from the OpenStack Foundation. +The source is hosted on `OpenStack's Gerrit server`_. + +.. _`OpenStack's Gerrit server`: https://git.starlingx.io + Indices and tables ==================