Browse Source

Add plumbing to support reno release notes

Change-Id: I1b4187ca74586912c36bfa3650951a1e8b5fa7a2
Colleen Murphy 5 months ago
parent
commit
2626d58c4d
5 changed files with 307 additions and 1 deletions
  1. 3
    0
      doc/requirements.txt
  2. 283
    0
      releasenotes/source/conf.py
  3. 8
    0
      releasenotes/source/index.rst
  4. 5
    0
      releasenotes/source/unreleased.rst
  5. 8
    1
      tox.ini

+ 3
- 0
doc/requirements.txt View File

@@ -0,0 +1,3 @@
1
+openstackdocstheme>=1.18.1 # Apache-2.0
2
+reno>=2.5.0 # Apache-2.0
3
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD

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

@@ -0,0 +1,283 @@
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
+# ldappool 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
+    'openstackdocstheme',
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'ldappool Release Notes'
59
+copyright = u'2018, ldappool Developers'
60
+
61
+# Release notes are version independent.
62
+
63
+# The short X.Y version.
64
+
65
+# The full version, including alpha/beta/rc tags.
66
+release = ''
67
+# The short X.Y version.
68
+version = ''
69
+
70
+# The language for content autogenerated by Sphinx. Refer to documentation
71
+# for a list of supported languages.
72
+# language = None
73
+
74
+# There are two options for replacing |today|: either, you set today to some
75
+# non-false value, then it is used:
76
+# today = ''
77
+# Else, today_fmt is used as the format for a strftime call.
78
+# today_fmt = '%B %d, %Y'
79
+
80
+# List of patterns, relative to source directory, that match files and
81
+# directories to ignore when looking for source files.
82
+exclude_patterns = []
83
+
84
+# The reST default role (used for this markup: `text`) to use for all
85
+# documents.
86
+# default_role = None
87
+
88
+# If true, '()' will be appended to :func: etc. cross-reference text.
89
+# add_function_parentheses = True
90
+
91
+# If true, the current module name will be prepended to all description
92
+# unit titles (such as .. function::).
93
+# add_module_names = True
94
+
95
+# If true, sectionauthor and moduleauthor directives will be shown in the
96
+# output. They are ignored by default.
97
+# show_authors = False
98
+
99
+# The name of the Pygments (syntax highlighting) style to use.
100
+pygments_style = 'sphinx'
101
+
102
+# A list of ignored prefixes for module index sorting.
103
+# modindex_common_prefix = []
104
+
105
+# If true, keep warnings as "system message" paragraphs in the built documents.
106
+# keep_warnings = False
107
+
108
+
109
+# -- Options for HTML output ----------------------------------------------
110
+
111
+# The theme to use for HTML and HTML Help pages.  See the documentation for
112
+# a list of builtin themes.
113
+html_theme = 'openstackdocs'
114
+
115
+# Theme options are theme-specific and customize the look and feel of a theme
116
+# further.  For a list of options available for each theme, see the
117
+# documentation.
118
+# html_theme_options = {}
119
+
120
+# Add any paths that contain custom themes here, relative to this directory.
121
+# html_theme_path = []
122
+
123
+# The name for this set of Sphinx documents.  If None, it defaults to
124
+# "<project> v<release> documentation".
125
+# html_title = None
126
+
127
+# A shorter title for the navigation bar.  Default is the same as html_title.
128
+# html_short_title = None
129
+
130
+# The name of an image file (relative to this directory) to place at the top
131
+# of the sidebar.
132
+# html_logo = None
133
+
134
+# The name of an image file (within the static path) to use as favicon of the
135
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
136
+# pixels large.
137
+# html_favicon = None
138
+
139
+# Add any paths that contain custom static files (such as style sheets) here,
140
+# relative to this directory. They are copied after the builtin static files,
141
+# so a file named "default.css" will overwrite the builtin "default.css".
142
+html_static_path = ['_static']
143
+
144
+# Add any extra paths that contain custom files (such as robots.txt or
145
+# .htaccess) here, relative to this directory. These files are copied
146
+# directly to the root of the documentation.
147
+# html_extra_path = []
148
+
149
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
150
+# using the given strftime format.
151
+# html_last_updated_fmt = '%b %d, %Y'
152
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
153
+
154
+# If true, SmartyPants will be used to convert quotes and dashes to
155
+# typographically correct entities.
156
+# html_use_smartypants = True
157
+
158
+# Custom sidebar templates, maps document names to template names.
159
+# html_sidebars = {}
160
+
161
+# Additional templates that should be rendered to pages, maps page names to
162
+# template names.
163
+# html_additional_pages = {}
164
+
165
+# If false, no module index is generated.
166
+# html_domain_indices = True
167
+
168
+# If false, no index is generated.
169
+# html_use_index = True
170
+
171
+# If true, the index is split into individual pages for each letter.
172
+# html_split_index = False
173
+
174
+# If true, links to the reST sources are added to the pages.
175
+# html_show_sourcelink = True
176
+
177
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
178
+# html_show_sphinx = True
179
+
180
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
181
+# html_show_copyright = True
182
+
183
+# If true, an OpenSearch description file will be output, and all pages will
184
+# contain a <link> tag referring to it.  The value of this option must be the
185
+# base URL from which the finished HTML is served.
186
+# html_use_opensearch = ''
187
+
188
+# This is the file name suffix for HTML files (e.g. ".xhtml").
189
+# html_file_suffix = None
190
+
191
+# Output file base name for HTML help builder.
192
+htmlhelp_basename = 'ldappoolReleaseNotesdoc'
193
+
194
+
195
+# -- Options for LaTeX output ---------------------------------------------
196
+
197
+latex_elements = {
198
+    # The paper size ('letterpaper' or 'a4paper').
199
+    # 'papersize': 'letterpaper',
200
+
201
+    # The font size ('10pt', '11pt' or '12pt').
202
+    # 'pointsize': '10pt',
203
+
204
+    # Additional stuff for the LaTeX preamble.
205
+    # 'preamble': '',
206
+}
207
+
208
+# Grouping the document tree into LaTeX files. List of tuples
209
+# (source start file, target name, title,
210
+#  author, documentclass [howto, manual, or own class]).
211
+latex_documents = [
212
+    ('index', 'ldappoolReleaseNotes.tex',
213
+     u'ldappool Release Notes Documentation',
214
+     u'ldappool Developers', 'manual'),
215
+]
216
+
217
+# The name of an image file (relative to this directory) to place at the top of
218
+# the title page.
219
+# latex_logo = None
220
+
221
+# For "manual" documents, if this is true, then toplevel headings are parts,
222
+# not chapters.
223
+# latex_use_parts = False
224
+
225
+# If true, show page references after internal links.
226
+# latex_show_pagerefs = False
227
+
228
+# If true, show URL addresses after external links.
229
+# latex_show_urls = False
230
+
231
+# Documents to append as an appendix to all manuals.
232
+# latex_appendices = []
233
+
234
+# If false, no module index is generated.
235
+# latex_domain_indices = True
236
+
237
+
238
+# -- Options for manual page output ---------------------------------------
239
+
240
+# One entry per manual page. List of tuples
241
+# (source start file, name, description, authors, manual section).
242
+man_pages = [
243
+    ('index', 'ldappoolreleasenotes',
244
+     u'ldappool Release Notes Documentation',
245
+     [u'ldappool Developers'], 1)
246
+]
247
+
248
+# If true, show URL addresses after external links.
249
+# man_show_urls = False
250
+
251
+
252
+# -- Options for Texinfo output -------------------------------------------
253
+
254
+# Grouping the document tree into Texinfo files. List of tuples
255
+# (source start file, target name, title, author,
256
+#  dir menu entry, description, category)
257
+texinfo_documents = [
258
+    ('index', 'ldappoolReleaseNotes',
259
+     u'ldappool Release Notes Documentation',
260
+     u'ldappool Developers', 'ldappoolReleaseNotes',
261
+     'Authentication plugins for the OpenStack Identity service.',
262
+     'Miscellaneous'),
263
+]
264
+
265
+# Documents to append as an appendix to all manuals.
266
+# texinfo_appendices = []
267
+
268
+# If false, no module index is generated.
269
+# texinfo_domain_indices = True
270
+
271
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
272
+# texinfo_show_urls = 'footnote'
273
+
274
+# If true, do not generate a @detailmenu in the "Top" node's menu.
275
+# texinfo_no_detailmenu = False
276
+
277
+# -- Options for Internationalization output ------------------------------
278
+locale_dirs = ['locale/']
279
+
280
+# -- Options for openstackdocstheme -------------------------------------------
281
+repository_name = 'openstack/ldappool'
282
+bug_project = 'ldappool'
283
+bug_tag = 'doc'

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

@@ -0,0 +1,8 @@
1
+======================
2
+ldappool 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
- 1
tox.ini View File

@@ -1,7 +1,7 @@
1 1
 [tox]
2 2
 minversion = 2.0
3 3
 skipsdist = True
4
-envlist = py27,py35,pep8,cover,docs
4
+envlist = py27,py35,pep8,cover,docs,releasenotes
5 5
 
6 6
 [testenv]
7 7
 usedevelop = True
@@ -56,6 +56,13 @@ basepython = python3
56 56
 commands=
57 57
     python setup.py build_sphinx
58 58
 
59
+[testenv:releasenotes]
60
+basepython = python3
61
+deps =
62
+    -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
63
+    -r{toxinidir}/doc/requirements.txt
64
+commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
65
+
59 66
 [testenv:lower-constraints]
60 67
 basepython = python3
61 68
 deps =

Loading…
Cancel
Save