Browse Source

Add reno for release notes management

Change-Id: If0590c842f73f0cf46cbe07db91b75ae296091d2
ricolin 1 year ago
parent
commit
2724e1bed7
6 changed files with 209 additions and 0 deletions
  1. 6
    0
      .gitignore
  2. 181
    0
      releasenotes/source/conf.py
  3. 13
    0
      releasenotes/source/index.rst
  4. 5
    0
      releasenotes/source/unreleased.rst
  5. 1
    0
      test-requirements.txt
  6. 3
    0
      tox.ini

+ 6
- 0
.gitignore View File

@@ -3,3 +3,9 @@
3 3
 *~
4 4
 .tox
5 5
 .testrepository
6
+build
7
+AUTHORS
8
+ChangeLog
9
+
10
+# Files created by releasenotes build
11
+releasenotes/build

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

@@ -0,0 +1,181 @@
1
+# -*- coding: utf-8 -*-
2
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
3
+#   not use this file except in compliance with the License. You may obtain
4
+#   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, WITHOUT
10
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
11
+#   License for the specific language governing permissions and limitations
12
+#   under the License.
13
+#
14
+# Heat Agent Release Note documentation build configuration file, created by
15
+# sphinx-quickstart on Fri Dec  8 10:57:54 2017.
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
+#
30
+# import os
31
+# import sys
32
+# sys.path.insert(0, os.path.abspath('.'))
33
+
34
+
35
+# -- General configuration ------------------------------------------------
36
+
37
+# If your documentation needs a minimal Sphinx version, state it here.
38
+#
39
+# needs_sphinx = '1.0'
40
+
41
+# Add any Sphinx extension module names here, as strings. They can be
42
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43
+# ones.
44
+extensions = [
45
+    'openstackdocstheme',
46
+    'reno.sphinxext',
47
+]
48
+
49
+# openstackdocstheme options
50
+repository_name = 'openstack/heat-agents'
51
+bug_project = 'heat'
52
+bug_tag = ''
53
+
54
+# Add any paths that contain templates here, relative to this directory.
55
+templates_path = ['_templates']
56
+
57
+# The suffix(es) of source filenames.
58
+# You can specify multiple suffix as a list of string:
59
+#
60
+# source_suffix = ['.rst', '.md']
61
+source_suffix = '.rst'
62
+
63
+# The master toctree document.
64
+master_doc = 'index'
65
+
66
+# General information about the project.
67
+project = u'Heat Agent Release Note'
68
+copyright = u'2017, Heat Developers'
69
+author = u'Heat Developers'
70
+
71
+# The version info for the project you're documenting, acts as replacement for
72
+# |version| and |release|, also used in various other places throughout the
73
+# built documents.
74
+#
75
+
76
+# The short X.Y version.
77
+version = ''
78
+# The full version, including alpha/beta/rc tags.
79
+release = ''
80
+
81
+# The language for content autogenerated by Sphinx. Refer to documentation
82
+# for a list of supported languages.
83
+#
84
+# This is also used if you do content translation via gettext catalogs.
85
+# Usually you set "language" from the command line for these cases.
86
+language = None
87
+
88
+# List of patterns, relative to source directory, that match files and
89
+# directories to ignore when looking for source files.
90
+# This patterns also effect to html_static_path and html_extra_path
91
+exclude_patterns = []
92
+
93
+# The name of the Pygments (syntax highlighting) style to use.
94
+pygments_style = 'sphinx'
95
+
96
+# If true, `todo` and `todoList` produce output, else they produce nothing.
97
+todo_include_todos = False
98
+
99
+
100
+# -- Options for HTML output ----------------------------------------------
101
+
102
+# The theme to use for HTML and HTML Help pages.  See the documentation for
103
+# a list of builtin themes.
104
+#
105
+html_theme = 'openstackdocs'
106
+
107
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
108
+
109
+# Theme options are theme-specific and customize the look and feel of a theme
110
+# further.  For a list of options available for each theme, see the
111
+# documentation.
112
+#
113
+# html_theme_options = {}
114
+
115
+# Add any paths that contain custom static files (such as style sheets) here,
116
+# relative to this directory. They are copied after the builtin static files,
117
+# so a file named "default.css" will overwrite the builtin "default.css".
118
+# html_static_path = ['_static']
119
+
120
+
121
+# -- Options for HTMLHelp output ------------------------------------------
122
+
123
+# Output file base name for HTML help builder.
124
+htmlhelp_basename = 'HeatAgentReleaseNotedoc'
125
+
126
+
127
+# -- Options for LaTeX output ---------------------------------------------
128
+
129
+latex_elements = {
130
+    # The paper size ('letterpaper' or 'a4paper').
131
+    #
132
+    # 'papersize': 'letterpaper',
133
+
134
+    # The font size ('10pt', '11pt' or '12pt').
135
+    #
136
+    # 'pointsize': '10pt',
137
+
138
+    # Additional stuff for the LaTeX preamble.
139
+    #
140
+    # 'preamble': '',
141
+
142
+    # Latex figure (float) alignment
143
+    #
144
+    # 'figure_align': 'htbp',
145
+}
146
+
147
+# Grouping the document tree into LaTeX files. List of tuples
148
+# (source start file, target name, title,
149
+#  author, documentclass [howto, manual, or own class]).
150
+latex_documents = [
151
+    (master_doc, 'HeatAgentReleaseNote.tex',
152
+     u'Heat Agent Release Note Documentation',
153
+     u'Heat Developers', 'manual'),
154
+]
155
+
156
+
157
+# -- Options for manual page output ---------------------------------------
158
+
159
+# One entry per manual page. List of tuples
160
+# (source start file, name, description, authors, manual section).
161
+man_pages = [
162
+    (master_doc, 'heatagentreleasenote',
163
+     u'Heat Agent Release Note Documentation',
164
+     [author], 1)
165
+]
166
+
167
+
168
+# -- Options for Texinfo output -------------------------------------------
169
+
170
+# Grouping the document tree into Texinfo files. List of tuples
171
+# (source start file, target name, title, author,
172
+#  dir menu entry, description, category)
173
+texinfo_documents = [
174
+    (master_doc, 'HeatAgentReleaseNote',
175
+     u'Heat Agent Release Note Documentation',
176
+     author, 'HeatAgentReleaseNote', 'One line description of project.',
177
+     'Miscellaneous'),
178
+]
179
+
180
+# -- Options for Internationalization output ------------------------------
181
+locale_dirs = ['locale/']

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

@@ -0,0 +1,13 @@
1
+Heat Agents Release Notes
2
+=========================
3
+
4
+.. toctree::
5
+   :maxdepth: 2
6
+   :caption: Contents:
7
+
8
+   unreleased
9
+
10
+Indices and tables
11
+==================
12
+
13
+* :ref:`search`

+ 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
test-requirements.txt View File

@@ -7,6 +7,7 @@ hacking>=0.12.0,!=0.13.0,<0.14  # Apache-2.0
7 7
 mock>=2.0  # BSD
8 8
 openstackdocstheme>=1.11.0 # Apache-2.0
9 9
 paunch>=1.0.0  # Apache-2.0
10
+reno>=2.5.0 # Apache-2.0
10 11
 requests>=2.10.0,!=2.12.2,!=2.13.0  # Apache-2.0
11 12
 requests-mock>=1.1  # Apache-2.0
12 13
 salt

+ 3
- 0
tox.ini View File

@@ -27,3 +27,6 @@ commands = {posargs}
27 27
 show-source = True
28 28
 builtins = _
29 29
 exclude=.venv,.git,.tox,*lib/python*,private,.eggs
30
+
31
+[testenv:releasenotes]
32
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

Loading…
Cancel
Save