From 3e8cee01d5f3a6678cb641f81f88782f57a8c61a Mon Sep 17 00:00:00 2001
From: Sylvain Bauza <sbauza@redhat.com>
Date: Mon, 23 Nov 2015 21:01:40 +0100
Subject: [PATCH] Add reno for release notes management

Since reno is the new tool for Relnotes, we need to add it
to novaclient  and provide some Sphinx docs for Liberty and Mitaka.

Change-Id: Ie42642a0e0037311cfa14cd8bf6b7041b62a4675
---
 .gitignore                                  |   3 +
 releasenotes/notes/.placeholder             |   0
 releasenotes/source/_static/.placeholder    |   0
 releasenotes/source/_templates/.placeholder |   0
 releasenotes/source/conf.py                 | 260 ++++++++++++++++++++
 releasenotes/source/index.rst               |  18 ++
 releasenotes/source/liberty.rst             |   6 +
 releasenotes/source/unreleased.rst          |   5 +
 test-requirements.txt                       |   3 +
 tox.ini                                     |   4 +-
 10 files changed, 298 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/.placeholder
 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/unreleased.rst

diff --git a/.gitignore b/.gitignore
index 5e1b43c4c..a0bd6f33a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,3 +16,6 @@ ChangeLog
 novaclient/versioninfo
 *.egg
 *egg-info
+
+# Files created by releasenotes build
+releasenotes/build
diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder
new file mode 100644
index 000000000..e69de29bb
diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder
new file mode 100644
index 000000000..e69de29bb
diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder
new file mode 100644
index 000000000..e69de29bb
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 000000000..996aff6d6
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,260 @@
+# -*- coding: utf-8 -*-
+#
+# Nova Client Release Notes documentation build configuration file, created by
+# sphinx-quickstart on Mon Nov 23 20:38:38 2015.
+#
+# 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.
+#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'Nova Client Release Notes'
+copyright = u'2015, Nova 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.
+#
+import pbr.version
+nova_version = pbr.version.VersionInfo('python-novaclient')
+# The short X.Y version.
+version = nova_version.canonical_version_string()
+# The full version, including alpha/beta/rc tags.
+release = nova_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 = 'NovaClientReleaseNotestdoc'
+
+
+# -- 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': '',
+}
+
+# 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', 'PythonNovaClient.tex', u'Nova Client Release Notes Documentation',
+   u'Nova 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', 'pythonnovaclient', u'Nova Client Release Notes Documentation',
+     [u'Nova 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', 'PythonNovaClient', u'Nova Client Release Notes Documentation',
+   u'Nova developers', 'PythonNovaClient', '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 000000000..6d8e6df7f
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,18 @@
+Welcome to Nova Client Release Notes documentation!
+===================================================
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   liberty
+   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 000000000..36217be84
--- /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/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 000000000..875030f9d
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
+============================
+Current Series Release Notes
+============================
+
+.. release-notes::
diff --git a/test-requirements.txt b/test-requirements.txt
index 41b09fbd9..252ca9790 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -16,3 +16,6 @@ testrepository>=0.0.18
 testscenarios>=0.4
 testtools>=1.4.0
 tempest-lib>=0.10.0
+
+# releasenotes
+reno>=0.1.1  # Apache2
diff --git a/tox.ini b/tox.ini
index 3ac09aef5..6fe9d7bab 100644
--- a/tox.ini
+++ b/tox.ini
@@ -30,6 +30,8 @@ commands = {posargs}
 commands =
   python setup.py build_sphinx
 
+[testenv:releasenotes]
+commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 
 [testenv:functional]
@@ -54,7 +56,7 @@ downloadcache = ~/cache/pip
 # Additional checks are also ignored on purpose: F811, F821
 ignore = F811,F821,H404,H405
 show-source = True
-exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build,doc/source/conf.py
+exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build,doc/source/conf.py,releasenotes
 
 [hacking]
 import_exceptions = novaclient.i18n