From e3d14a16f260b97d07ec6f2c76db8babb1af4784 Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Thu, 18 Jan 2018 09:18:24 -0800 Subject: [PATCH] Update and add listener stats release notes Adds a release note for the listener stats feature and updates the release notes theme to the new openstackdocs theme. Change-Id: Ia1ba31176b4c84fe7f09d7bdc62f20412875c709 --- .../listener-stats-db49f99a8a0dd90f.yaml | 4 +++ releasenotes/source/conf.py | 30 ++++++++++++------- 2 files changed, 24 insertions(+), 10 deletions(-) create mode 100644 releasenotes/notes/listener-stats-db49f99a8a0dd90f.yaml diff --git a/releasenotes/notes/listener-stats-db49f99a8a0dd90f.yaml b/releasenotes/notes/listener-stats-db49f99a8a0dd90f.yaml new file mode 100644 index 0000000..6ec9109 --- /dev/null +++ b/releasenotes/notes/listener-stats-db49f99a8a0dd90f.yaml @@ -0,0 +1,4 @@ +--- +features: + - | + Adds support for querying the listener statistics. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 4eef1f9..5822018 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,6 +42,11 @@ extensions = [ 'reno.sphinxext', ] +# openstackdocstheme options +repository_name = 'openstack/python-octaviaclient' +bug_project = 'octavia' +bug_tag = 'doc' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -111,7 +116,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 = 'default' +html_theme = 'openstackdocs' # 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 @@ -149,7 +154,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -189,7 +194,7 @@ html_static_path = ['_static'] # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'GlanceReleaseNotesdoc' +htmlhelp_basename = 'PythonOctaviaClientReleaseNotesdoc' # -- Options for LaTeX output --------------------------------------------- @@ -209,8 +214,9 @@ latex_elements = { # (source start file, target name, title, # documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', - u'Glance Developers', 'manual'), + ('index', 'PythonOctaviaClientReleaseNotes.tex', + u'python-octaviaclient Release Notes Documentation', + u'Octavia Developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -239,8 +245,10 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'glancereleasenotes', u'Glance Release Notes Documentation', - [u'Glance Developers'], 1) + ('index', + 'pythonoctaviaclientreleasenotes', + u'python-octaviaclient Release Notes Documentation', + [u'Octavia Developers'], 1) ] # If true, show URL addresses after external links. @@ -253,9 +261,11 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', - u'Glance Developers', 'GlanceReleaseNotes', - 'One line description of project.', + ('index', + 'PythonOctaviaClientReleaseNotes', + u'python-octaviaclient Release Notes Documentation', + u'Octavia Developers', 'PythonOctaviaClientReleaseNotes', + 'OpenStack client plugin for Octavia.', 'Miscellaneous'), ]