Browse Source

Merge "Add release notes for keystoneauth"

Jenkins 3 years ago
parent
commit
2eb534900c

+ 3
- 1
.gitignore View File

@@ -20,4 +20,6 @@ doc/source/api
20 20
 .project
21 21
 .pydevproject
22 22
 # Temporary files created during test, but not removed
23
-examples/pki/certs/tmp*
23
+examples/pki/certs/tmp*
24
+# Files created by releasenotes build
25
+releasenotes/build

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


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


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


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

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

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

@@ -0,0 +1,8 @@
1
+============================
2
+ keystoneauth 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
test-requirements.txt View File

@@ -16,6 +16,7 @@ oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
16 16
 oslotest>=1.10.0 # Apache-2.0
17 17
 os-testr>=0.4.1
18 18
 pycrypto>=2.6
19
+reno>=0.1.1  # Apache2
19 20
 requests-mock>=0.6.0 # Apache-2.0
20 21
 sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
21 22
 tempest-lib>=0.10.0

+ 4
- 1
tox.ini View File

@@ -1,7 +1,7 @@
1 1
 [tox]
2 2
 minversion = 1.6
3 3
 skipsdist = True
4
-envlist = py27,py34,pep8
4
+envlist = py27,py34,pep8,releasenotes
5 5
 
6 6
 [testenv]
7 7
 usedevelop = True
@@ -57,5 +57,8 @@ exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common*
57 57
 commands=
58 58
     python setup.py build_sphinx
59 59
 
60
+[testenv:releasenotes]
61
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
62
+
60 63
 [hacking]
61 64
 local-check-factory = keystoneauth1.hacking.checks.factory

Loading…
Cancel
Save