Browse Source

Add reno for release notes management

The release management team have indicated this is their preferred way
to collect release notes in future.

Closes-Bug: #1634356

Change-Id: I10fbc4cb80d53d4bf5b8b6365c7472b7706d46b2
tags/1.45.0
ChangBo Guo(gcb) 2 years ago
parent
commit
bfbee9fc9f

+ 2
- 0
.gitignore View File

@@ -20,3 +20,5 @@ ChangeLog
20 20
 # Generated by etcd
21 21
 etcd-v*
22 22
 default.etcd
23
+# reno build
24
+releasenotes/build

+ 3
- 0
releasenotes/notes/add-reno-996dd44974d53238.yaml View File

@@ -0,0 +1,3 @@
1
+---
2
+other:
3
+  - Introduce reno for deployer release notes.

+ 0
- 0
releasenotes/source/_static/.placeholder View File


+ 0
- 0
releasenotes/source/_templates/.placeholder View File


+ 276
- 0
releasenotes/source/conf.py View File

@@ -0,0 +1,276 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+# This file is execfile()d with the current directory set to its
16
+# containing dir.
17
+#
18
+# Note that not all possible configuration values are present in this
19
+# autogenerated file.
20
+#
21
+# All configuration values have a default; values that are commented out
22
+# serve to show the default.
23
+
24
+# If extensions (or modules to document with autodoc) are in another directory,
25
+# add these directories to sys.path here. If the directory is relative to the
26
+# documentation root, use os.path.abspath to make it absolute, like shown here.
27
+# sys.path.insert(0, os.path.abspath('.'))
28
+
29
+# -- General configuration ------------------------------------------------
30
+
31
+# If your documentation needs a minimal Sphinx version, state it here.
32
+# needs_sphinx = '1.0'
33
+
34
+# Add any Sphinx extension module names here, as strings. They can be
35
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36
+# ones.
37
+extensions = [
38
+    'oslosphinx',
39
+    'reno.sphinxext',
40
+]
41
+
42
+# Add any paths that contain templates here, relative to this directory.
43
+templates_path = ['_templates']
44
+
45
+# The suffix of source filenames.
46
+source_suffix = '.rst'
47
+
48
+# The encoding of source files.
49
+# source_encoding = 'utf-8-sig'
50
+
51
+# The master toctree document.
52
+master_doc = 'index'
53
+
54
+# General information about the project.
55
+project = u'tooz Release Notes'
56
+copyright = u'2016, tooz Developers'
57
+
58
+# The version info for the project you're documenting, acts as replacement for
59
+# |version| and |release|, also used in various other places throughout the
60
+# built documents.
61
+#
62
+# The short X.Y version.
63
+# The full version, including alpha/beta/rc tags.
64
+import pkg_resources
65
+release = pkg_resources.get_distribution('tooz').version
66
+# The short X.Y version.
67
+version = release
68
+
69
+# The language for content autogenerated by Sphinx. Refer to documentation
70
+# for a list of supported languages.
71
+# language = None
72
+
73
+# There are two options for replacing |today|: either, you set today to some
74
+# non-false value, then it is used:
75
+# today = ''
76
+# Else, today_fmt is used as the format for a strftime call.
77
+# today_fmt = '%B %d, %Y'
78
+
79
+# List of patterns, relative to source directory, that match files and
80
+# directories to ignore when looking for source files.
81
+exclude_patterns = []
82
+
83
+# The reST default role (used for this markup: `text`) to use for all
84
+# documents.
85
+# default_role = None
86
+
87
+# If true, '()' will be appended to :func: etc. cross-reference text.
88
+# add_function_parentheses = True
89
+
90
+# If true, the current module name will be prepended to all description
91
+# unit titles (such as .. function::).
92
+# add_module_names = True
93
+
94
+# If true, sectionauthor and moduleauthor directives will be shown in the
95
+# output. They are ignored by default.
96
+# show_authors = False
97
+
98
+# The name of the Pygments (syntax highlighting) style to use.
99
+pygments_style = 'sphinx'
100
+
101
+# A list of ignored prefixes for module index sorting.
102
+# modindex_common_prefix = []
103
+
104
+# If true, keep warnings as "system message" paragraphs in the built documents.
105
+# keep_warnings = False
106
+
107
+
108
+# -- Options for HTML output ----------------------------------------------
109
+
110
+# The theme to use for HTML and HTML Help pages.  See the documentation for
111
+# a list of builtin themes.
112
+html_theme = 'default'
113
+
114
+# Theme options are theme-specific and customize the look and feel of a theme
115
+# further.  For a list of options available for each theme, see the
116
+# documentation.
117
+# html_theme_options = {}
118
+
119
+# Add any paths that contain custom themes here, relative to this directory.
120
+# html_theme_path = []
121
+
122
+# The name for this set of Sphinx documents.  If None, it defaults to
123
+# "<project> v<release> documentation".
124
+# html_title = None
125
+
126
+# A shorter title for the navigation bar.  Default is the same as html_title.
127
+# html_short_title = None
128
+
129
+# The name of an image file (relative to this directory) to place at the top
130
+# of the sidebar.
131
+# html_logo = None
132
+
133
+# The name of an image file (within the static path) to use as favicon of the
134
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
135
+# pixels large.
136
+# html_favicon = None
137
+
138
+# Add any paths that contain custom static files (such as style sheets) here,
139
+# relative to this directory. They are copied after the builtin static files,
140
+# so a file named "default.css" will overwrite the builtin "default.css".
141
+html_static_path = ['_static']
142
+
143
+# Add any extra paths that contain custom files (such as robots.txt or
144
+# .htaccess) here, relative to this directory. These files are copied
145
+# directly to the root of the documentation.
146
+# html_extra_path = []
147
+
148
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
149
+# using the given strftime format.
150
+# html_last_updated_fmt = '%b %d, %Y'
151
+
152
+# If true, SmartyPants will be used to convert quotes and dashes to
153
+# typographically correct entities.
154
+# html_use_smartypants = True
155
+
156
+# Custom sidebar templates, maps document names to template names.
157
+# html_sidebars = {}
158
+
159
+# Additional templates that should be rendered to pages, maps page names to
160
+# template names.
161
+# html_additional_pages = {}
162
+
163
+# If false, no module index is generated.
164
+# html_domain_indices = True
165
+
166
+# If false, no index is generated.
167
+# html_use_index = True
168
+
169
+# If true, the index is split into individual pages for each letter.
170
+# html_split_index = False
171
+
172
+# If true, links to the reST sources are added to the pages.
173
+# html_show_sourcelink = True
174
+
175
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
176
+# html_show_sphinx = True
177
+
178
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
179
+# html_show_copyright = True
180
+
181
+# If true, an OpenSearch description file will be output, and all pages will
182
+# contain a <link> tag referring to it.  The value of this option must be the
183
+# base URL from which the finished HTML is served.
184
+# html_use_opensearch = ''
185
+
186
+# This is the file name suffix for HTML files (e.g. ".xhtml").
187
+# html_file_suffix = None
188
+
189
+# Output file base name for HTML help builder.
190
+htmlhelp_basename = 'toozReleaseNotesDoc'
191
+
192
+
193
+# -- Options for LaTeX output ---------------------------------------------
194
+
195
+latex_elements = {
196
+    # The paper size ('letterpaper' or 'a4paper').
197
+    # 'papersize': 'letterpaper',
198
+
199
+    # The font size ('10pt', '11pt' or '12pt').
200
+    # 'pointsize': '10pt',
201
+
202
+    # Additional stuff for the LaTeX preamble.
203
+    # 'preamble': '',
204
+}
205
+
206
+# Grouping the document tree into LaTeX files. List of tuples
207
+# (source start file, target name, title,
208
+#  author, documentclass [howto, manual, or own class]).
209
+latex_documents = [
210
+    ('index', 'toozReleaseNotes.tex',
211
+     u'tooz Release Notes Documentation',
212
+     u'tooz Developers', 'manual'),
213
+]
214
+
215
+# The name of an image file (relative to this directory) to place at the top of
216
+# the title page.
217
+# latex_logo = None
218
+
219
+# For "manual" documents, if this is true, then toplevel headings are parts,
220
+# not chapters.
221
+# latex_use_parts = False
222
+
223
+# If true, show page references after internal links.
224
+# latex_show_pagerefs = False
225
+
226
+# If true, show URL addresses after external links.
227
+# latex_show_urls = False
228
+
229
+# Documents to append as an appendix to all manuals.
230
+# latex_appendices = []
231
+
232
+# If false, no module index is generated.
233
+# latex_domain_indices = True
234
+
235
+
236
+# -- Options for manual page output ---------------------------------------
237
+
238
+# One entry per manual page. List of tuples
239
+# (source start file, name, description, authors, manual section).
240
+man_pages = [
241
+    ('index', 'toozReleaseNotes',
242
+     u'tooz Release Notes Documentation',
243
+     [u'tooz Developers'], 1)
244
+]
245
+
246
+# If true, show URL addresses after external links.
247
+# man_show_urls = False
248
+
249
+
250
+# -- Options for Texinfo output -------------------------------------------
251
+
252
+# Grouping the document tree into Texinfo files. List of tuples
253
+# (source start file, target name, title, author,
254
+#  dir menu entry, description, category)
255
+texinfo_documents = [
256
+    ('index', 'toozReleaseNotes',
257
+     u'tooz Release Notes Documentation',
258
+     u'tooz Developers', 'toozReleaseNotes',
259
+     'One line description of project.',
260
+     'Miscellaneous'),
261
+]
262
+
263
+# Documents to append as an appendix to all manuals.
264
+# texinfo_appendices = []
265
+
266
+# If false, no module index is generated.
267
+# texinfo_domain_indices = True
268
+
269
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
270
+# texinfo_show_urls = 'footnote'
271
+
272
+# If true, do not generate a @detailmenu in the "Top" node's menu.
273
+# texinfo_no_detailmenu = False
274
+
275
+# -- Options for Internationalization output ------------------------------
276
+locale_dirs = ['locale/']

+ 8
- 0
releasenotes/source/index.rst View File

@@ -0,0 +1,8 @@
1
+====================
2
+ tooz Release Notes
3
+====================
4
+
5
+ .. toctree::
6
+    :maxdepth: 1
7
+
8
+    unreleased

+ 5
- 0
releasenotes/source/unreleased.rst View File

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

+ 1
- 0
setup.cfg View File

@@ -64,6 +64,7 @@ test =
64 64
   coverage>=3.6 # Apache-2.0
65 65
   fixtures>=3.0.0 # Apache-2.0/BSD
66 66
   pifpaf>=0.10.0 # Apache-2.0
67
+  reno>=1.8.0 # Apache-2.0
67 68
 doc =
68 69
   sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
69 70
   oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0

+ 4
- 0
tox.ini View File

@@ -99,3 +99,7 @@ import_exceptions = six.moves
99 99
 [doc8]
100 100
 
101 101
 ignore-path = doc/source/compatibility.rst,doc/source/history.rst
102
+
103
+
104
+[testenv:releasenotes]
105
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

Loading…
Cancel
Save