From 1deddefcea50496a0ed6ff97a5376d6f661df967 Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Mon, 25 Jun 2018 13:41:26 +0200 Subject: [PATCH] Add reno for release notes management Change-Id: I14d8b7304f276f76d0fd2a1347dd8a53fdc2a989 --- .gitignore | 3 + lower-constraints.txt | 1 + releasenotes/notes/.placeholder | 0 releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 186 ++++++++++++++++++++ releasenotes/source/index.rst | 8 + releasenotes/source/unreleased.rst | 5 + test-requirements.txt | 2 + tox.ini | 5 + zuul.d/project.yaml | 2 + 11 files changed, 212 insertions(+) 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/unreleased.rst diff --git a/.gitignore b/.gitignore index 9c612cf..398155f 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,9 @@ nosetests.xml # Translations *.mo +# Files created by releasenotes build +releasenotes/build + # Mr Developer .mr.developer.cfg .project diff --git a/lower-constraints.txt b/lower-constraints.txt index e32d223..fb8c673 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -41,6 +41,7 @@ python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 pyzmq===14.3.1 +reno==2.5.0 requests==2.14.2 requestsexceptions==1.2.0 restructuredtext-lint==1.1.1 diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..533573e --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,186 @@ +# -*- 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. + +# VirtualBMC Release Notes documentation build configuration file, created by +# sphinx-quickstart on Mon Jun 25 13:25:41 2018. +# +# 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' +] + +# 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 = 'VirtualBMC Release Notes' +copyright = '2018, Ironic Developers' +author = 'Ironic 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# 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 = 'alabaster' + +# 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. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'VirtualBMCReleaseNotesdoc' + + +# -- 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, 'VirtualBMCReleaseNotes.tex', + 'VirtualBMC Release Notes Documentation', + 'Ironic 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, 'virtualbmcreleasenotes', + 'VirtualBMC Release Notes 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, 'VirtualBMCReleaseNotes', + 'VirtualBMC Release Notes Documentation', + author, 'VirtualBMCReleaseNotes', '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..d540541 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +======================== +VirtualBMC Release Notes +======================== + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..cd22aab --- /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 c7524c6..d174f56 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -16,3 +16,5 @@ testtools>=2.2.0 # MIT os-testr>=1.0.0 # Apache-2.0 mock>=2.0.0 # BSD +# releasenotes +reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 46b2463..32e209c 100644 --- a/tox.ini +++ b/tox.ini @@ -36,6 +36,11 @@ commands = python setup.py test --coverage --testr-args='{posargs}' basepython = python3 commands = python setup.py build_sphinx +[testenv:releasenotes] +basepython = python3 +commands = + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + [testenv:debug] basepython = python3 commands = oslo_debug_helper {posargs} diff --git a/zuul.d/project.yaml b/zuul.d/project.yaml index 0de9f53..cf0f6f0 100644 --- a/zuul.d/project.yaml +++ b/zuul.d/project.yaml @@ -1,4 +1,6 @@ - project: + templates: + - release-notes-jobs check: jobs: - virtualbmc-tempest-dsvm-ironic-pxe_ipmitool-src