From 2724e1bed7f1e454e70b2d4115f4ebbd7941b81d Mon Sep 17 00:00:00 2001 From: ricolin Date: Fri, 8 Dec 2017 11:24:02 +0800 Subject: [PATCH] Add reno for release notes management Change-Id: If0590c842f73f0cf46cbe07db91b75ae296091d2 --- .gitignore | 6 + releasenotes/source/conf.py | 181 +++++++++++++++++++++++++++++ releasenotes/source/index.rst | 13 +++ releasenotes/source/unreleased.rst | 5 + test-requirements.txt | 1 + tox.ini | 3 + 6 files changed, 209 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/.gitignore b/.gitignore index 7693c17..5072799 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,9 @@ *~ .tox .testrepository +build +AUTHORS +ChangeLog + +# Files created by releasenotes build +releasenotes/build diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..c2456aa --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,181 @@ +# -*- 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. +# +# Heat Agent Release Note documentation build configuration file, created by +# sphinx-quickstart on Fri Dec 8 10:57:54 2017. +# +# 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. +# +# import os +# import sys +# 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 = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +# openstackdocstheme options +repository_name = 'openstack/heat-agents' +bug_project = 'heat' +bug_tag = '' + +# 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' + +# General information about the project. +project = u'Heat Agent Release Note' +copyright = u'2017, Heat Developers' +author = u'Heat 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 = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# 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 patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = 'openstackdocs' + +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# 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'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'HeatAgentReleaseNotedoc' + + +# -- 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, 'HeatAgentReleaseNote.tex', + u'Heat Agent Release Note Documentation', + u'Heat Developers', '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, 'heatagentreleasenote', + u'Heat Agent Release Note 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, 'HeatAgentReleaseNote', + u'Heat Agent Release Note Documentation', + author, 'HeatAgentReleaseNote', 'One line description of project.', + 'Miscellaneous'), +] + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..5887c17 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,13 @@ +Heat Agents Release Notes +========================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + unreleased + +Indices and tables +================== + +* :ref:`search` diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..875030f --- /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 25e1afa..acfaf6a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,6 +7,7 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 mock>=2.0 # BSD openstackdocstheme>=1.11.0 # Apache-2.0 paunch>=1.0.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 requests>=2.10.0,!=2.12.2,!=2.13.0 # Apache-2.0 requests-mock>=1.1 # Apache-2.0 salt diff --git a/tox.ini b/tox.ini index 3642d02..50e8a3f 100644 --- a/tox.ini +++ b/tox.ini @@ -27,3 +27,6 @@ commands = {posargs} show-source = True builtins = _ exclude=.venv,.git,.tox,*lib/python*,private,.eggs + +[testenv:releasenotes] +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html