Browse Source

Add basic structure for ReNo

ReNo [1] is the release management tool in OpenStack.
This patch adds the basic structure to start using it.

* Update .gitignore
* Add a basic note "use-reno"
* Add releasenotes/ dir and basic files
* Add python files: setup.cfg, setup.py, test-requirements.txt and
  tox.ini.

[1] http://docs.openstack.org/developer/reno

Change-Id: I205b179a6bff595c4eee564836d77b1981aa61c9
tags/8.0.0
Emilien Macchi 3 years ago
parent
commit
7695d6deb2

+ 4
- 0
.gitignore View File

@@ -9,3 +9,7 @@ coverage/
9 9
 *.swp
10 10
 *.iml
11 11
 openstack/
12
+
13
+# Files created by releasenotes build
14
+releasenotes/build
15
+.tox

+ 6
- 0
releasenotes/notes/use-reno-1caaec4ba5aa4285.yaml View File

@@ -0,0 +1,6 @@
1
+---
2
+prelude: >
3
+   Release notes are generated by Reno.
4
+features:
5
+  - Release notes are no longer maintained by hand, we now use the reno tool to
6
+    manage them.

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


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

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

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

@@ -0,0 +1,8 @@
1
+===========================
2
+puppet-glance 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::

+ 13
- 0
setup.cfg View File

@@ -0,0 +1,13 @@
1
+[metadata]
2
+name = puppet-glance
3
+summary = Puppet module for OpenStack Glance
4
+description-file =
5
+    README.md
6
+author = Puppet Labs and OpenStack Contributors
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Intended Audience :: Developers
11
+    Intended Audience :: System Administrators
12
+    License :: OSI Approved :: Apache Software License
13
+    Operating System :: POSIX :: Linux

+ 22
- 0
setup.py View File

@@ -0,0 +1,22 @@
1
+#!/usr/bin/env python
2
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
3
+#
4
+# Licensed under the Apache License, Version 2.0 (the "License");
5
+# you may not use this file except in compliance with the License.
6
+# You may obtain a copy of the License at
7
+#
8
+#    http://www.apache.org/licenses/LICENSE-2.0
9
+#
10
+# Unless required by applicable law or agreed to in writing, software
11
+# distributed under the License is distributed on an "AS IS" BASIS,
12
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13
+# implied.
14
+# See the License for the specific language governing permissions and
15
+# limitations under the License.
16
+
17
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
18
+import setuptools
19
+
20
+setuptools.setup(
21
+    setup_requires=['pbr'],
22
+    pbr=True)

+ 4
- 0
test-requirements.txt View File

@@ -0,0 +1,4 @@
1
+# this is required for the docs build jobs
2
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
3
+oslosphinx>=2.5.0 # Apache-2.0
4
+reno>=0.1.1 # Apache-2.0

+ 8
- 0
tox.ini View File

@@ -0,0 +1,8 @@
1
+[tox]
2
+minversion = 1.6
3
+skipsdist = True
4
+envlist = releasenotes
5
+
6
+[testenv:releasenotes]
7
+deps = -rtest-requirements.txt
8
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

Loading…
Cancel
Save