Browse Source

[Doc] Release Notes Management

Baseline changes to comply with Release Notes Management
based in Reno [0]:

* Use build-openstack-releasenotes job for release notes
  (We can't use the OpenStack releasenotes template as it includes
  publish jobs, stx needs its own)
* Add newnote tox environment as convenience for creating new release
  notes, re-using the releasenotes venv.
* Remove the unused 'true' tox environment if it exists.

[0] https://docs.openstack.org/reno/latest/

Story: 2003101
Task: 26514

Change-Id: I7fda1f84d336940dc8851eb053d451981e36bf4d
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Abraham Arce 7 months ago
parent
commit
2440f88207

+ 3
- 0
.gitignore View File

@@ -24,3 +24,6 @@ sdist
24 24
 
25 25
 # Sphinx documentation
26 26
 doc/build/
27
+
28
+# Release Notes documentation
29
+releasenotes/build

+ 2
- 0
.zuul.yaml View File

@@ -4,6 +4,7 @@
4 4
       - build-openstack-docs-pti
5 5
     check:
6 6
       jobs:
7
+        - build-openstack-releasenotes
7 8
         - openstack-tox-linters
8 9
         - sysinv-tox-py27
9 10
         - sysinv-tox-flake8
@@ -13,6 +14,7 @@
13 14
         - configutilities-tox-flake8
14 15
     gate:
15 16
       jobs:
17
+        - build-openstack-releasenotes
16 18
         - openstack-tox-linters
17 19
         - sysinv-tox-py27
18 20
         - sysinv-tox-flake8

+ 2
- 1
doc/requirements.txt View File

@@ -1,2 +1,3 @@
1
-sphinx>=1.6.2
2 1
 openstackdocstheme>=1.19.0 # Apache-2.0
2
+reno>=0.1.1 # Apache2
3
+sphinx>=1.6.2

+ 3
- 0
releasenotes/notes/release-summary-6738ff2f310f9b57.yaml View File

@@ -0,0 +1,3 @@
1
+---
2
+prelude: >
3
+    These release notes cover the initial release of StarlingX.

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

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

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

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

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

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

+ 15
- 0
tox.ini View File

@@ -11,6 +11,7 @@ setenv = VIRTUAL_ENV={envdir}
11 11
          OS_STDERR_CAPTURE=1
12 12
          OS_TEST_TIMEOUT=60
13 13
 deps = -r{toxinidir}/test-requirements.txt
14
+whitelist_externals = reno
14 15
 
15 16
 [testenv:linters]
16 17
 whitelist_externals = bash
@@ -54,3 +55,17 @@ commands =
54 55
     rm -rf doc/build
55 56
     sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
56 57
 whitelist_externals = rm
58
+
59
+[testenv:releasenotes]
60
+basepython = python3
61
+deps = -r{toxinidir}/doc/requirements.txt
62
+commands =
63
+    rm -rf releasenotes/build
64
+    sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
65
+whitelist_externals = rm
66
+
67
+[testenv:newnote]
68
+# Re-use the releasenotes venv
69
+envdir = {toxworkdir}/releasenotes
70
+deps = -r{toxinidir}/doc/requirements.txt
71
+commands = reno new {posargs}

Loading…
Cancel
Save