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 <dtroyer@gmail.com>
This commit is contained in:
parent
84ecd490a6
commit
ee9618869d
|
@ -12,3 +12,6 @@
|
||||||
jobs:
|
jobs:
|
||||||
- build-openstack-releasenotes
|
- build-openstack-releasenotes
|
||||||
- openstack-tox-linters
|
- openstack-tox-linters
|
||||||
|
post:
|
||||||
|
jobs:
|
||||||
|
- publish-stx-tox
|
||||||
|
|
|
@ -42,8 +42,9 @@ release = u'0.1'
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = ['openstackdocstheme'
|
extensions = [
|
||||||
]
|
'openstackdocstheme',
|
||||||
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
@ -81,7 +82,7 @@ pygments_style = 'sphinx'
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# 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
|
# 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
|
# further. For a list of options available for each theme, see the
|
||||||
|
|
|
@ -7,9 +7,19 @@ StarlingX Distributed Cloud Client
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
: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:`search`
|
||||||
|
* :ref:`genindex`
|
||||||
|
|
|
@ -93,7 +93,7 @@ pygments_style = 'sphinx'
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# 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
|
# 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
|
# further. For a list of options available for each theme, see the
|
||||||
|
@ -191,8 +191,13 @@ latex_elements = {
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
latex_documents = [
|
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
|
# 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
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
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.
|
# If true, show URL addresses after external links.
|
||||||
|
@ -235,10 +245,15 @@ man_pages = [
|
||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
('index', 'stx-distcloud-clientReleaseNotes', u'stx-distcloud-client Release Notes',
|
(
|
||||||
u'StarlingX', 'stx-distcloud-clientreleasenotes',
|
'index',
|
||||||
'StarlingX Distributed Cloud Client',
|
'stx-distcloud-clientReleaseNotes',
|
||||||
'Miscellaneous'),
|
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.
|
# Documents to append as an appendix to all manuals.
|
||||||
|
|
Loading…
Reference in New Issue