Browse Source

Add release notes

Change-Id: I99e5fa5596928c977826ac62e7408ec6629ec55d
Dmitry Tantsur 6 months ago
parent
commit
192b740d96

+ 1
- 0
.gitignore View File

@@ -8,6 +8,7 @@
8 8
 _build
9 9
 doc/source/reference/api/
10 10
 doc/source/.doctrees/
11
+releasenotes/build/
11 12
 
12 13
 # Packages/installer info
13 14
 *.egg

+ 1
- 0
.zuul.yaml View File

@@ -175,6 +175,7 @@
175 175
       - openstack-lower-constraints-jobs
176 176
       - openstack-cover-jobs
177 177
       - publish-openstack-docs-pti
178
+      - release-notes-jobs-python3
178 179
     check:
179 180
       jobs:
180 181
         - metalsmith-integration-glance-localboot-centos7

+ 1
- 0
doc/requirements.txt View File

@@ -1,6 +1,7 @@
1 1
 # The order of packages is significant, because pip processes them in the order
2 2
 # of appearance. Changing the order has an impact on the overall integration
3 3
 # process, which may cause wedges in the gate later.
4
+reno>=2.5.0 # Apache-2.0
4 5
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5 6
 sphinxcontrib-apidoc>=0.2.0  # BSD
6 7
 openstackdocstheme>=1.18.1 # Apache-2.0

+ 1
- 0
lower-constraints.txt View File

@@ -49,6 +49,7 @@ python-ironicclient==1.14.0
49 49
 python-mimeparse==1.6.0
50 50
 pytz==2018.4
51 51
 PyYAML==3.12
52
+reno==2.5.0
52 53
 requests==2.18.4
53 54
 requestsexceptions==1.4.0
54 55
 restructuredtext-lint==1.1.3

+ 0
- 0
releasenotes/notes/.placeholder View File


+ 3
- 0
releasenotes/notes/initial-5afe4a5f6a13fa8e.yaml View File

@@ -0,0 +1,3 @@
1
+---
2
+prelude: >
3
+    This is the first release where release notes were introduced.

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


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


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

@@ -0,0 +1,198 @@
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
+    'reno.sphinxext',
39
+]
40
+
41
+try:
42
+    import openstackdocstheme
43
+    extensions.append('openstackdocstheme')
44
+except ImportError:
45
+    openstackdocstheme = None
46
+
47
+repository_name = 'openstack/metalsmith'
48
+bug_project = 'metalsmith'
49
+bug_tag = ''
50
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
51
+
52
+# Add any paths that contain templates here, relative to this directory.
53
+templates_path = ['_templates']
54
+
55
+# The suffix of source filenames.
56
+source_suffix = '.rst'
57
+
58
+# The encoding of source files.
59
+# source_encoding = 'utf-8-sig'
60
+
61
+# The master toctree document.
62
+master_doc = 'index'
63
+
64
+# General information about the project.
65
+project = u'MetalSmith Release Notes'
66
+copyright = u'2018, MetalSmith Developers'
67
+
68
+# Release notes are version independent.
69
+# The short X.Y version.
70
+version = ''
71
+# The full version, including alpha/beta/rc tags.
72
+release = ''
73
+
74
+# The language for content autogenerated by Sphinx. Refer to documentation
75
+# for a list of supported languages.
76
+# language = None
77
+
78
+# There are two options for replacing |today|: either, you set today to some
79
+# non-false value, then it is used:
80
+# today = ''
81
+# Else, today_fmt is used as the format for a strftime call.
82
+# today_fmt = '%B %d, %Y'
83
+
84
+# List of patterns, relative to source directory, that match files and
85
+# directories to ignore when looking for source files.
86
+exclude_patterns = []
87
+
88
+# The reST default role (used for this markup: `text`) to use for all
89
+# documents.
90
+# default_role = None
91
+
92
+# If true, '()' will be appended to :func: etc. cross-reference text.
93
+# add_function_parentheses = True
94
+
95
+# If true, the current module name will be prepended to all description
96
+# unit titles (such as .. function::).
97
+# add_module_names = True
98
+
99
+# If true, sectionauthor and moduleauthor directives will be shown in the
100
+# output. They are ignored by default.
101
+# show_authors = False
102
+
103
+# The name of the Pygments (syntax highlighting) style to use.
104
+pygments_style = 'sphinx'
105
+
106
+# A list of ignored prefixes for module index sorting.
107
+# modindex_common_prefix = []
108
+
109
+# If true, keep warnings as "system message" paragraphs in the built documents.
110
+# keep_warnings = False
111
+
112
+
113
+# -- Options for HTML output ----------------------------------------------
114
+
115
+# The theme to use for HTML and HTML Help pages.  See the documentation for
116
+# a list of builtin themes.
117
+if openstackdocstheme is not None:
118
+    html_theme = 'openstackdocs'
119
+else:
120
+    html_theme = 'default'
121
+
122
+# Theme options are theme-specific and customize the look and feel of a theme
123
+# further.  For a list of options available for each theme, see the
124
+# documentation.
125
+# html_theme_options = {}
126
+
127
+# Add any paths that contain custom themes here, relative to this directory.
128
+# html_theme_path = []
129
+
130
+# The name for this set of Sphinx documents.  If None, it defaults to
131
+# "<project> v<release> documentation".
132
+# html_title = None
133
+
134
+# A shorter title for the navigation bar.  Default is the same as html_title.
135
+# html_short_title = None
136
+
137
+# The name of an image file (relative to this directory) to place at the top
138
+# of the sidebar.
139
+# html_logo = None
140
+
141
+# The name of an image file (within the static path) to use as favicon of the
142
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
143
+# pixels large.
144
+# html_favicon = None
145
+
146
+# Add any paths that contain custom static files (such as style sheets) here,
147
+# relative to this directory. They are copied after the builtin static files,
148
+# so a file named "default.css" will overwrite the builtin "default.css".
149
+html_static_path = ['_static']
150
+
151
+# Add any extra paths that contain custom files (such as robots.txt or
152
+# .htaccess) here, relative to this directory. These files are copied
153
+# directly to the root of the documentation.
154
+# html_extra_path = []
155
+
156
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
157
+# using the given strftime format.
158
+# html_last_updated_fmt = '%b %d, %Y'
159
+
160
+# If true, SmartyPants will be used to convert quotes and dashes to
161
+# typographically correct entities.
162
+# html_use_smartypants = True
163
+
164
+# Custom sidebar templates, maps document names to template names.
165
+# html_sidebars = {}
166
+
167
+# Additional templates that should be rendered to pages, maps page names to
168
+# template names.
169
+# html_additional_pages = {}
170
+
171
+# If false, no module index is generated.
172
+# html_domain_indices = True
173
+
174
+# If false, no index is generated.
175
+# html_use_index = True
176
+
177
+# If true, the index is split into individual pages for each letter.
178
+# html_split_index = False
179
+
180
+# If true, links to the reST sources are added to the pages.
181
+# html_show_sourcelink = True
182
+
183
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
184
+# html_show_sphinx = True
185
+
186
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
187
+# html_show_copyright = True
188
+
189
+# If true, an OpenSearch description file will be output, and all pages will
190
+# contain a <link> tag referring to it.  The value of this option must be the
191
+# base URL from which the finished HTML is served.
192
+# html_use_opensearch = ''
193
+
194
+# This is the file name suffix for HTML files (e.g. ".xhtml").
195
+# html_file_suffix = None
196
+
197
+# Output file base name for HTML help builder.
198
+htmlhelp_basename = 'MetalSmithReleaseNotesdoc'

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

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

+ 8
- 0
tox.ini View File

@@ -54,6 +54,14 @@ deps =
54 54
 commands =
55 55
   sphinx-build -a -E -W -b html doc/source doc/build/html
56 56
 
57
+[testenv:releasenotes]
58
+basepython = python3
59
+deps =
60
+  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
61
+  -r{toxinidir}/doc/joined-requirements.txt
62
+commands =
63
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
64
+
57 65
 [testenv:lower-constraints]
58 66
 basepython = python3
59 67
 deps =

Loading…
Cancel
Save