From 565eab5ee5ac033538ffd9932a7e2346a0a354ba Mon Sep 17 00:00:00 2001
From: Chris Dent <cdent@anticdent.org>
Date: Wed, 24 Oct 2018 18:08:44 +0100
Subject: [PATCH] Make tox -ereleasenotes work

One of the things Placement will need when it is properly publishing
itself is a working release notes job. Until this change there was
no source/conf.py or source/index.rst for releasenotes job to use.
This adds it, we can now create release notes output, with the
openstackdocs theme.

However: Because the placement repo has no branches, all the existing
release notes in releasenotes/notes are considered 'unreleased', which
makes for a lot of noise at the page generated by unreleased.rst.

What this probably means is that we will want to clear out all the
release notes that pre-date extraction and start anew. An experiment to
try removing some notes shows that the releasenotes will produce some
messages about missing release notes, but neither warn nor error, and
the output is good, so this should work out okay for us.

That will be easy to do now that we have a working releasenotes tox env.

Note: This change does not add any jobs to zuul, it just makes tox
work for releasenotes.

Change-Id: I61a7ce492395e0ae69dd0401a141ea4bb93516b9
---
 releasenotes/source/conf.py        | 78 ++++++++++++++++++++++++++++++
 releasenotes/source/index.rst      | 13 +++++
 releasenotes/source/unreleased.rst |  5 ++
 3 files changed, 96 insertions(+)
 create mode 100644 releasenotes/source/conf.py
 create mode 100644 releasenotes/source/index.rst
 create mode 100644 releasenotes/source/unreleased.rst

diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 000000000..270a023ea
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+# Keep these empty so that releasesnotes do not display an associated
+# version.
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- 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',
+]
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Placement Release Notes'
+copyright = u'2018, Placement developers'
+author = u'OpenStack'
+# openstackdocstheme options
+repository_name = 'openstack/placement'
+# TODO(cdent): This will change to something else later.
+bug_project = 'nova'
+bug_tag = 'placement'
+
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# 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.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'openstackdocs'
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 000000000..e8aa7650b
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,13 @@
+
+Placement Release Notes
+=======================
+
+.. note:: The placement service was extracted from the nova service at the
+          beginning of the Stein cycle. Release history prior to Stein can
+          be found in the `Nova Release Notes
+          <https://docs.openstack.org/releasenotes/nova/>`_.
+
+.. toctree::
+   :maxdepth: 1
+
+   unreleased
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 000000000..cd22aabcc
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
+==============================
+ Current Series Release Notes
+==============================
+
+.. release-notes::