Add specs publish job

Also set the theme to alabaster until starlingxdocs theme
is available in a released openstackdocstheme module.

Also makes a change to the sample spec header to format
the index page properly.

Change-Id: I960e49483cd7f17aec5cc38dcaa634c19ad8789a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
This commit is contained in:
Dean Troyer 2018-10-03 22:03:22 -05:00
parent 476398fd15
commit a00f7d2bb7
5 changed files with 45 additions and 4 deletions

View File

@ -1,9 +1,13 @@
---
- project:
templates:
- build-openstack-docs-pti
check:
jobs:
- build-openstack-sphinx-docs
- openstack-tox-linters
gate:
jobs:
- openstack-tox-linters
post:
jobs:
- publish-stx-specs

View File

@ -40,8 +40,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']
@ -79,7 +80,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

View File

@ -2,5 +2,39 @@ StarlingX Specs
===============
.. toctree::
:glob:
:maxdepth: 2
:caption: Contents:
StarlingX Project Specifications
--------------------------------
.. toctree::
:glob:
:maxdepth: 1
specs/*
Approved Specifications
-----------------------
.. toctree::
:glob:
:maxdepth: 1
specs/approved/*
Implemented Specifications
--------------------------
.. toctree::
:glob:
:maxdepth: 1
specs/implemented/*
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

1
doc/source/specs Symbolic link
View File

@ -0,0 +1 @@
../../specs

View File

@ -2,6 +2,7 @@
.. Many thanks to the OpenStack Nova team for the Example Spec that formed the basis for this document.
=======================
StarlingX: Example Spec
=======================