Fix octavia-tempest-plugin releasenotes theme

The octavia tempest plugin release notes were still configured to
use the old oslosphinx theme.
This patch updates the release notes to use the openstackdocstheme.

This patch also enables the release notes to be built and published.

Change-Id: I7877854a86d4cf86614ec281b4840cef50abd4f2
This commit is contained in:
Michael Johnson 2019-04-01 13:42:19 -07:00
parent c9414e8419
commit 4d46e2ffc0
2 changed files with 20 additions and 12 deletions

View File

@ -38,10 +38,14 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'oslosphinx', 'openstackdocstheme',
'reno.sphinxext', 'reno.sphinxext',
] ]
# openstackdocstheme options
repository_name = 'openstack/octavia-tempest-plugin'
use_storyboard = True
# 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']
@ -111,7 +115,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 = 'default' html_theme = 'openstackdocs'
# 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
@ -189,12 +193,12 @@ html_static_path = ['_static']
# html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'GlanceReleaseNotesdoc' htmlhelp_basename = 'OctaviaTempestPluginReleaseNotesdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { # latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper', # 'papersize': 'letterpaper',
@ -203,14 +207,15 @@ latex_elements = {
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
# 'preamble': '', # 'preamble': '',
} # }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (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', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', ('index', 'OctaviaTempestPluginReleaseNotes.tex',
u'Glance Developers', 'manual'), u'Octavia Tempest Plugin Release Notes Documentation',
u'Octavia Developers', '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
@ -239,8 +244,9 @@ 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', 'glancereleasenotes', u'Glance Release Notes Documentation', ('index', 'octaviatempestpluginreleasenotes',
[u'Glance Developers'], 1) u'Octavia Tempest Plugin Release Notes Documentation',
[u'Octavia Developers'], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@ -253,9 +259,10 @@ 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', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', ('index', 'OctaviaTempestPluginReleaseNotes',
u'Glance Developers', 'GlanceReleaseNotes', u'Octavia Tempest Plugin Release Notes Documentation',
'One line description of project.', u'Octavia Developers', 'OctaviaTempestPluginReleaseNotes',
'Octavia Load Balancing as a Service for OpenStack.',
'Miscellaneous'), 'Miscellaneous'),
] ]

View File

@ -5,6 +5,7 @@
- check-requirements - check-requirements
- publish-openstack-docs-pti - publish-openstack-docs-pti
- tempest-plugin-jobs - tempest-plugin-jobs
- release-notes-jobs-python3
check: check:
jobs: jobs:
- octavia-v2-dsvm-noop-api - octavia-v2-dsvm-noop-api