From dc1d36ba1b9992869f1753cfc0c6fd61d771ee6c Mon Sep 17 00:00:00 2001 From: Tin Lam Date: Wed, 28 Nov 2018 02:48:40 -0600 Subject: [PATCH] Add releasenotes This patch set adds releasenotes (reno) to the airship-pegleg repository. Change-Id: I1ed98460f40eb851ca53f8a5b68ab17f8272a2e2 Signed-off-by: Tin Lam --- .zuul.yaml | 1 + doc/requirements.txt | 9 +- doc/source/images/architecture-pegleg.png | Bin 37602 -> 37604 bytes releasenotes/notes/.placeholder | 0 releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 174 ++++++++++++++++++++ releasenotes/source/index.rst | 7 + releasenotes/source/unreleased.rst | 5 + tox.ini | 9 + 10 files changed, 203 insertions(+), 2 deletions(-) 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/.zuul.yaml b/.zuul.yaml index ef871107..9356aca1 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -14,6 +14,7 @@ templates: - openstack-python36-jobs - openstack-cover-jobs + - release-notes-jobs-python3 check: jobs: - openstack-tox-pep8 diff --git a/doc/requirements.txt b/doc/requirements.txt index d3cd9da8..0f8bf5cd 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,7 +3,12 @@ # process, which may cause wedges in the gate later. # Documentation -sphinx>=1.6.2 -sphinx_rtd_theme==0.2.4 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +oslosphinx>=4.7.0 # Apache-2.0 +sphinx_rtd_theme + # UML image generation plantuml + +# Releasenotes +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png index 85428fbecddc16ad1cba24731fff24c8b9862b94..8b526cce7d7ca77ca7e827637e8564026e9478cd 100644 GIT binary patch delta 535 zcmV+y0_gqXr2^!o0+3mM{ApBJbZ~58Zgh2RYybfO004NLZBk8dn?Mk~uf%^Cak39s z!L5^sgB97(d=y%@IPSr+qBTs&DzIxUi(9MefA1_{$B`nW)y~Iz`{pq>wc*+{Rp~JM z@ysX9jN^kF7i+t9+LPBEp`od*@?!sS(0j%dr8m-C= zj7C#fN3swSHxB!E23cTHVsQj?5zOQJ9@8g2gnr+lObyRoVXms3lBB9W63w{Yij2#i zCdEvnft2P$m=VN7nQz+8uXw19dLz%d;agr?X{t7bMmuuHN;mLeo%d5d<=Z33x@1d@ zb%c`r1w3#1_5vh-BF{_w&9!~(!*mO

0#mQXV}dMDIe!N@8s8WO183jZKyJ)^+uh zk6{Gf^qt>!47!sqphfXw?7(3ZK#03i9V#-nr$TKPAn$q|c0*^oL2OZSX&#dp_NZ&2 zB>1E8g?~NrKMfL!zNtNoFTuYGd_S1@@VK0VtqDq-ig-l2#vkSS4K(+$odplxdqUKYKGl{~k5zf>qLyt~!kY ziM$$JJdG#b)}Jt1Db0&HONMw&fDQRTobwF-7*OuA^=f8RBbG?gll<@<4t&pq~aZMZf~RXWUm zJTppzyNFzep)|rA!M$CrmKS0AGrov^r#E-5MLug@At5n)ec>{Hcj2$Y05)?ajaKCr ze18g?NESlk)?xoHAWJMtEKYzff_Z$`WBSCW(1$(B)bQ*T=BnB&Nvi4-(TwYz$hhoj zQp_|ONNGNV89_Xh`L^x+fydgYck-MYzT>r(rfO4Yv?F({v;z+|c|YY-zB_@eOSaTl zM=05E!1Jc>CqN>9^1Q@1uI*u;rdxo8I?S$?^5h{QdKWrY5@T~`i`(RRY^r>;uB)GY zTtwhaKlp9Opgs8lS`;tF4!np$Sm3@?$BNADsZiSokaxWfyQZ~$L2OxaX&#dp4ybFP zBn19=6kPeic#t*{9x?;t0D@5%Oz4Nl)f{Yn$Obpd7;4pj=nNqjwb5eN7$O+5dw$^X ztD)ysVF)%Ftdb$5(J4uq4niww^|AYP(lx=YGU;BKw)yK9ZzkyOQIjrMCmrd!(-@M- zZ~o|MJn?qHgwd1I+z44fN|%FG2(ggOAGW|}-jvpXOyyJ#N&R>4ip5+O4KGL=N;X%d XNgt_}vi|`GjRfO_Qe1emUIK=Ye~bdJ diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 00000000..e69de29b diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 00000000..9c1dcffe --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,174 @@ +# -*- 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 = 'pegleg' +copyright = '2018, Pegleg Authors' +author = 'Pegleg Authors' + +# 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 = [ + '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 = '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. +# +# 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 = 'AirshipPeglegdoc' + + +# -- 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, 'AirshipPegleg.tex', 'Airship Pegleg Documentation', + 'Airship 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, 'airshippegleg', 'Airship Pegleg 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, 'AirshipPegleg', 'Airship Pegleg Documentation', + author, 'AirshipPegleg', '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'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 00000000..c34dd6d2 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,7 @@ +Pegleg Release Notes +====================== + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 00000000..875030f9 --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/tox.ini b/tox.ini index 070a0d97..53f825b8 100644 --- a/tox.ini +++ b/tox.ini @@ -59,6 +59,15 @@ deps = commands = pytest --cov=pegleg --cov-report html:cover --cov-report xml:cover/coverage.xml --cov-report term --cov-fail-under 84 tests/ +[testenv:releasenotes] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands = + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +whitelist_externals = + rm + [testenv:venv] commands = {posargs}