From 589d16e914d62def64d2b9a76cc84c438896a49b Mon Sep 17 00:00:00 2001
From: Sharat Sharma <sharat.sharma@nectechnologies.in>
Date: Wed, 5 Oct 2016 19:23:15 +0530
Subject: [PATCH] Maintain releasenotes for vitrage

All the components of openstack maintain releasenotes. Similarly,
vitrage must also maintain releasenotes. This adds the releasenotes
directory to the vitrage repo.

Change-Id: I83892a67063e51b704d25f37c9b9ce279ddc6a2e
Implements: blueprint maintain-releasenotes
---
 releasenotes/notes/.placeholder             |  0
 releasenotes/source/_static/.placeholder    |  0
 releasenotes/source/_templates/.placeholder |  0
 releasenotes/source/conf.py                 | 75 +++++++++++++++++++++
 releasenotes/source/index.rst               | 17 +++++
 releasenotes/source/unreleased.rst          |  5 ++
 test-requirements.txt                       |  1 +
 tox.ini                                     |  4 ++
 8 files changed, 102 insertions(+)
 create mode 100644 releasenotes/notes/.placeholder
 create mode 100644 releasenotes/source/_static/.placeholder
 create mode 100644 releasenotes/source/_templates/.placeholder
 create mode 100755 releasenotes/source/conf.py
 create mode 100644 releasenotes/source/index.rst
 create mode 100644 releasenotes/source/unreleased.rst

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 100755
index 000000000..8917f5cd4
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,75 @@
+# -*- 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
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    # 'sphinx.ext.intersphinx',
+    'oslosphinx'
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'vitrage releasenotes'
+copyright = u'2016, Vitrage developers'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Vitrage ReleaseNotes' % project,
+     u'Vitrage developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 000000000..a18968cb4
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,17 @@
+Vitrage Release Notes
+=====================
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   unreleased
+
+
+   Indices and tables
+   ==================
+
+   * :ref:`genindex`
+     * :ref:`search`
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 893f3e943..d03293c77 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -31,3 +31,4 @@ testtools>=1.4.0 # MIT
 stevedore>=1.16.0 # Apache-2.0
 voluptuous>=0.8.9 # BSD License
 sympy>=0.7.6 # BSD
+reno>=1.8.0 # Apache2
diff --git a/tox.ini b/tox.ini
index f0981188d..62e20ecbc 100644
--- a/tox.ini
+++ b/tox.ini
@@ -40,3 +40,7 @@ show-source = True
 ignore = E123,E125
 builtins = _
 exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build
+
+
+[testenv:releasenotes]
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html