Add releasenotes

Per comment left in [0], this patch set adds releasenote to the repository.

[0] https://review.openstack.org/#/c/614425/

Change-Id: Idc2608b7a88b3a6343736e6b68f16baf570d41ff
Signed-off-by: Tin Lam <tin@irrational.io>

.gitignore

@@ -13,6 +13,7 @@ dist/*
 
 # Documentation
 doc*/build/*
+releasenotes/build/*
 
 # MacOS
 *.DS_Store

doc-ko_KR/requirements.txt

@@ -0,0 +1 @@
+../requirements.txt

doc/requirements.txt

@@ -0,0 +1 @@
+../requirements.txt

doc/source/conf.py

@@ -52,7 +52,6 @@ use_storyboard = True
 # ones.
 extensions = [
     'openstackdocstheme',
-    'oslosphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

releasenotes/source/conf.py

@@ -0,0 +1,182 @@
+# -*- 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 -----------------------------------------------------
+
+project = 'OpenStack Helm Docs Release Notes'
+copyright = '2018, OpenStack Developers'
+author = 'OpenStack Helm Docs Authors'
+
+# openstackdocstheme options
+repository_name = 'openstack/openstack-helm-docs'
+bug_project = '64'
+bug_tag = ''
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+use_storyboard = True
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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',
+]
+
+# 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', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = None
+
+
+# -- 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenStack-Helm-Docsdoc'
+
+
+# -- 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 = [
+    (master_doc, 'OpenStack-Helm-Docs.tex', 'OpenStack-Helm-Docs Documentation',
+     'openstack-helm-authors', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'openstack-helm-docs', 'OpenStack-Helm-Docs Documentation',
+     [author], 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 = [
+    (master_doc, 'OpenStack-Helm-Docs', 'OpenStack-Helm-Docs Documentation',
+     author, 'OpenStack-Helm-Docs', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']

releasenotes/source/index.rst

@@ -0,0 +1,8 @@
+===================================
+openstack-helm-docs Release Notes
+===================================
+
+.. toctree::
+   :maxdepth: 1
+
+   unreleased

releasenotes/source/unreleased.rst

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

requirements.txt

@@ -4,5 +4,7 @@
 
 pbr>=2.0.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
 openstackdocstheme>=1.19.0 # Apache-2.0
+
+# Releasenotes
+reno>=2.5.0 # Apache-2.0

tox.ini

@@ -21,7 +21,16 @@ commands = {posargs}
 
 [testenv:docs]
 basepython = python3
+deps = {[testenv]deps}
 description =
   Build main documentation.
 commands =
   bash -c "./tools/build-docs.sh"
+
+[testenv:releasenotes]
+basepython = python3
+deps = {[testenv]deps}
+description =
+  Build release notes
+commands =
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

zuul.d/project.yaml

@@ -14,3 +14,4 @@
 - project:
     templates:
       - publish-openstack-docs-pti
+      - release-notes-jobs-python3