From 801ef2e84346b7e94868a3f9730d3e50a95fd037 Mon Sep 17 00:00:00 2001
From: Steven Dake <stdake@cisco.com>
Date: Tue, 22 Mar 2016 17:11:28 -0700
Subject: [PATCH] Add reno support

For proper release note generation on the releases.openstack.org
website, this change will need to be backported into mitaka and
liberty as well.  Then a special one-file reno file will have to
be added for mitaka describing the features and the same story
for liberty.

See log of the discussion here:
http://eavesdrop.openstack.org/irclogs/%23openstack-release/%23openstack-release.2016-03-23.log.html#t2016-03-23T18:00:05

Change-Id: I3c298ae08ec4645f384ea5829cb0851fe82f4557
Partially-Implements: blueprint add-reno
---
 .gitignore                                    |   3 +
 .../notes/add-reno-f5e9ff4d9ccfa785.yaml      |   3 +
 releasenotes/source/_static/.placeholder      |   0
 releasenotes/source/_templates/.placeholder   |   0
 releasenotes/source/conf.py                   | 251 ++++++++++++++++++
 releasenotes/source/index.rst                 |  19 ++
 releasenotes/source/liberty.rst               |   6 +
 releasenotes/source/mitaka.rst                |   6 +
 releasenotes/source/unreleased.rst            |   5 +
 setup.cfg                                     |   7 +-
 test-requirements.txt                         |   1 +
 tox.ini                                       |   6 +
 12 files changed, 306 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/add-reno-f5e9ff4d9ccfa785.yaml
 create mode 100644 releasenotes/source/_static/.placeholder
 create mode 100644 releasenotes/source/_templates/.placeholder
 create mode 100644 releasenotes/source/conf.py
 create mode 100644 releasenotes/source/index.rst
 create mode 100644 releasenotes/source/liberty.rst
 create mode 100644 releasenotes/source/mitaka.rst
 create mode 100644 releasenotes/source/unreleased.rst

diff --git a/.gitignore b/.gitignore
index 91ed32b951..7cae5350e5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -40,5 +40,8 @@ dev/vagrant/storage/
 # Files generated by JetBrains
 .idea/
 
+# Files created by reno build
+releasenotes/build
+
 # Others
 .DS_Store
diff --git a/releasenotes/notes/add-reno-f5e9ff4d9ccfa785.yaml b/releasenotes/notes/add-reno-f5e9ff4d9ccfa785.yaml
new file mode 100644
index 0000000000..a7cce39a6e
--- /dev/null
+++ b/releasenotes/notes/add-reno-f5e9ff4d9ccfa785.yaml
@@ -0,0 +1,3 @@
+---
+features:
+  - Start using reno.
diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 0000000000..f575e6d359
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,251 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import os
+import sys
+
+from kolla.version import version_info as kolla_version
+
+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 = [
+    'oslosphinx',
+    'reno.sphinxext',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Kolla Release Notes'
+copyright = u'2015, Kolla 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.
+#
+# The short X.Y version.
+version = kolla_version.canonical_version_string()
+# The full version, including alpha/beta/rc tags.
+release = kolla_version.version_string_with_vcs()
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = 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 = 'default'
+
+# 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 themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'KollaReleaseNotesdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+# 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', 'KollaReleaseNotes.tex', u'Kolla Release Notes Documentation',
+     u'Kolla developers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'kollareleasenotes', u'Kolla Release Notes Documentation',
+     [u'Kolla developers'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- 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', 'KollaReleaseNotes', u'Kolla Release Notes Documentation',
+     u'Kolla developers', 'KollaReleaseNotes',
+     'One line description of project.', 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 0000000000..79312ad07e
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,19 @@
+Welcome to Kolla Release Notes documentation
+=============================================
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   liberty
+   mitaka
+   unreleased
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/releasenotes/source/liberty.rst b/releasenotes/source/liberty.rst
new file mode 100644
index 0000000000..36217be844
--- /dev/null
+++ b/releasenotes/source/liberty.rst
@@ -0,0 +1,6 @@
+==============================
+ Liberty Series Release Notes
+==============================
+
+.. release-notes::
+   :branch: origin/stable/liberty
diff --git a/releasenotes/source/mitaka.rst b/releasenotes/source/mitaka.rst
new file mode 100644
index 0000000000..e545609650
--- /dev/null
+++ b/releasenotes/source/mitaka.rst
@@ -0,0 +1,6 @@
+===================================
+ Mitaka Series Release Notes
+===================================
+
+.. release-notes::
+   :branch: origin/stable/mitaka
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 0000000000..875030f9d0
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
+============================
+Current Series Release Notes
+============================
+
+.. release-notes::
diff --git a/setup.cfg b/setup.cfg
index d4e4ba39be..59441c59e8 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -47,4 +47,9 @@ setup-hooks =
 [build_sphinx]
 all_files = 1
 build-dir = doc/build
-source-dir = doc/
+source-dir = doc
+
+[build_releasenotes]
+all_files = 1
+build-dir = releasenotes/build
+source-dir = releasenotes/source
diff --git a/test-requirements.txt b/test-requirements.txt
index 19037e43e9..8b0b577a43 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,6 +7,7 @@ hacking>=0.10.0
 oslo.log>=1.14.0 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
+reno>=0.1.1 # Apache2
 PyYAML>=3.1.0 # MIT
 python-barbicanclient>=3.3.0 # Apache-2.0
 python-ceilometerclient>=2.2.1 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 753b6f359b..40fa81bc11 100644
--- a/tox.ini
+++ b/tox.ini
@@ -6,6 +6,7 @@ envlist = py34,py27,pep8,pypy
 [testenv]
 usedevelop=True
 whitelist_externals = find
+                      rm
 install_command = pip install -U {opts} {packages}
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
@@ -180,6 +181,11 @@ whitelist_externals = which
 commands=
   oslo-config-generator --config-file etc/oslo-config-generator/kolla-build.conf
 
+[testenv:releasenotes]
+commands =
+  rm -rf releasenotes/build
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+
 [flake8]
 show-source = True
 exclude=.eggs,.git,.tox,doc