Browse Source

Add reno for release notes management

Change-Id: Iee09083a2c582e086aa64ba1516d36e37e4a8512
changes/50/649450/3
Slawek Kaplonski 3 years ago
committed by Federico Ressi
parent
commit
31c6f20983
  1. 3
      .gitignore
  2. 6
      docs/requirements.txt
  3. 0
      releasenotes/notes/.placeholder
  4. 0
      releasenotes/source/_static/.placeholder
  5. 0
      releasenotes/source/_templates/.placeholder
  6. 155
      releasenotes/source/conf.py
  7. 12
      releasenotes/source/index.rst
  8. 5
      releasenotes/source/unreleased.rst
  9. 1
      test-requirements.txt
  10. 4
      tox.ini
  11. 1
      zuul.d/project.yaml

3
.gitignore

@ -23,3 +23,6 @@ doc/build/*
dist/
etc/
zuul/versioninfo
# Files created by releasenotes build
releasenotes/build

6
docs/requirements.txt

@ -0,0 +1,6 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,>=1.6.2 # BSD
oslotest>=3.2.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0

0
releasenotes/notes/.placeholder

0
releasenotes/source/_static/.placeholder

0
releasenotes/source/_templates/.placeholder

155
releasenotes/source/conf.py

@ -0,0 +1,155 @@
# -*- 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 = u'Tobiko Release Notes'
copyright = u'2019, Tobiko developers'
# 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 = [
'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 = '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 = 'default'
# 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 = 'TobikoReleaseNotesdoc'
# -- 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, 'TobikoReleaseNotes.tex', u'Tobiko Release Notes Documentation',
u'Tobiko 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, 'tobikoreleasenotes', u'Tobiko Release Notes Documentation',
[u'Tobiko developers'], 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, 'TobikoReleaseNotes', u'Tobiko Release Notes Documentation',
u'Tobiko developers', 'TobikoReleaseNotes', 'One line description of project.',
'Miscellaneous'),
]

12
releasenotes/source/index.rst

@ -0,0 +1,12 @@
.. Tobiko Release Notes documentation master file, created by
sphinx-quickstart on Tue Apr 2 22:09:06 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Tobiko Release Notes's documentation!
================================================
.. toctree::
:maxdepth: 1
unreleased

5
releasenotes/source/unreleased.rst

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

1
test-requirements.txt

@ -2,3 +2,4 @@
coverage!=4.4,>=4.0 # Apache-2.0
mock>=2.0 # BSD
reno>=2.5.0 # Apache-2.0

4
tox.ini

@ -121,6 +121,10 @@ setenv =
{[tobiko]setenv}
PYTHON=python
[testenv:releasenotes]
basepython = python3
deps = -r{toxinidir}/docs/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[flake8]
# E125 continuation line does not distinguish itself from next logical line

1
zuul.d/project.yaml

@ -3,6 +3,7 @@
templates:
- check-requirements
- tempest-plugin-jobs
- release-notes-jobs-python3
check:
jobs:
- openstack-tox-pep8

Loading…
Cancel
Save