Add Reno release notes support to Kuryr-Kubernetes

Add support for publishing release notes using Reno [1].

[1] http://docs.openstack.org/developer/reno/

closes-Bug: #1733344
Change-Id: I3fbb1cf2f7238c7edaa3137255e5af5ca29f1d89

.gitignore

@@ -34,6 +34,9 @@ output/*/index.html
 # Sphinx
 doc/build
 
+# Files created by releasenotes build
+releasenotes/build
+
 # pbr generates these
 AUTHORS
 ChangeLog

doc/source/conf.py

@@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
-    'openstackdocstheme'
+    'openstackdocstheme',
+    'reno.sphinxext'
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy

releasenotes/notes/started-using-reno-90dbe9da108ec5c4.yaml

@@ -0,0 +1,2 @@
+other:
+  - Started using reno for release notes.

releasenotes/source/README.rst

@@ -0,0 +1,10 @@
+=====================================
+ Kuryr-Kubernetes Release Notes Howto
+=====================================
+
+Release notes are a new feature for documenting new features in
+OpenStack projects. Background on the process, tooling, and
+methodology is documented in a `mailing list post by Doug Hellmann <http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html>`_.
+
+For information on how to create release notes, please consult the
+`Release Notes documentation <https://docs.openstack.org/reno/latest/>`_.

releasenotes/source/conf.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# Kuryr-Kubernetes documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 17 09:02:23 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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',
+    'reno.sphinxext']
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Kuryr-Kubernetes'
+copyright = u'2017, Kuryr-Kubernetes Developers'
+author = u'Kuryr-Kubernetes Developers'
+
+# 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.
+#
+from kuryr_kubernetes import version as kuryr_version
+# The short X.Y version.
+version = kuryr_version.version_info.version_string()
+# The full version, including alpha/beta/rc tags.
+release = kuryr_version.version_info.release_string()
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+# language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+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
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Kuryr-Kubernetesdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    ('index', 'Kuryr-KubernetesReleaseNotes.tex',
+     u'Kuryr-Kubernetes Release Notes Documentation',
+     u'Kuryr-Kubernetes Developers', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'kuryr-kubernetesreleasenotes',
+     u'Kuryr-Kubernetes Release Notes Documentation',
+     [u'Kuryr-Kubernetes Developers'], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    ('index', 'Kuryr-KubernetesReleaseNotes',
+     u'Kuryr-Kubernetes Release Notes Documentation',
+     u'Kuryr-Kubernetes Developers',
+     'Kuryr-KubernetesReleaseNotes',
+     'One line description of project.',
+     'Miscellaneous'),
+]

releasenotes/source/index.rst

@@ -0,0 +1,11 @@
+Welcome to Kuryr-Kubernetes Release Notes documentation!
+========================================================
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 1
+
+   README.rst
+   unreleased

releasenotes/source/unreleased.rst

@@ -0,0 +1,5 @@
+============================
+Current Series Release Notes
+============================
+
+.. release-notes::

tox.ini

@@ -53,7 +53,7 @@ show-source = true
 enable-extensions = H106,H203
 
 # TODO(dougw) neutron/tests/unit/vmware exclusion is a temporary services split hack
-exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools,.ropeproject,rally-scenarios,neutron/tests/unit/vmware*
+exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools,.ropeproject,rally-scenarios,neutron/tests/unit/vmware*,releasenotes
 
 [testenv:pylint]
 deps =
@@ -68,3 +68,6 @@ local-check-factory = neutron_lib.hacking.checks.factory
 
 [testenv:genconfig]
 commands = oslo-config-generator --config-file=etc/oslo-config-generator/kuryr.conf
+
+[testenv:releasenotes]
+commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html