summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWitek Bedyk <witold.bedyk@suse.com>2019-02-01 09:39:16 +0100
committerWitek Bedyk <witold.bedyk@suse.com>2019-02-01 09:40:26 +0100
commit0f316afc8742a890d03344e2c8b62f277c3b888e (patch)
tree117c5b392d0e5a17c049278665092a88e1bcb72f
parente6f2f2b6fee6592ab4bc83863bc66eb3b1e30b8f (diff)
Configure releasenotes job
Notes
Notes (review): Code-Review+2: Joseph Davis <joseph.davis@suse.com> Code-Review+1: Thomas Bechtold <tbechtold@suse.com> Code-Review+2: Doug Szumski <doug@stackhpc.com> Workflow+1: Doug Szumski <doug@stackhpc.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 13 Feb 2019 15:51:28 +0000 Reviewed-on: https://review.openstack.org/634379 Project: openstack/monasca-notification Branch: refs/heads/master
-rw-r--r--.zuul.yaml1
-rw-r--r--doc/requirements.txt6
-rw-r--r--releasenotes/source/conf.py229
-rw-r--r--releasenotes/source/index.rst21
-rw-r--r--releasenotes/source/unreleased.rst5
-rw-r--r--tox.ini6
6 files changed, 268 insertions, 0 deletions
diff --git a/.zuul.yaml b/.zuul.yaml
index 867ef85..4c727a5 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -6,6 +6,7 @@
6 - openstack-python-jobs 6 - openstack-python-jobs
7 - openstack-python35-jobs 7 - openstack-python35-jobs
8 - openstack-python36-jobs 8 - openstack-python36-jobs
9 - release-notes-jobs-python3
9 check: 10 check:
10 jobs: 11 jobs:
11 - monasca-tempest-python2-influxdb: 12 - monasca-tempest-python2-influxdb:
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..ef03b33
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,6 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5openstackdocstheme>=1.18.1 # Apache-2.0
6reno>=2.5.0 # Apache-2.0 \ No newline at end of file
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 0000000..c1e9f4c
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,229 @@
1# Licensed under the Apache License, Version 2.0 (the "License");
2# you may not use this file except in compliance with the License.
3# You may obtain a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS,
9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10# implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14# -- General configuration ------------------------------------------------
15
16# If your documentation needs a minimal Sphinx version, state it here.
17needs_sphinx = '1.6'
18
19# Add any Sphinx extension module names here, as strings. They can be
20# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
21# ones.
22extensions = [
23 'openstackdocstheme',
24 'reno.sphinxext'
25]
26
27# Add any paths that contain templates here, relative to this directory.
28templates_path = ['_templates']
29
30# The suffix of source filenames.
31source_suffix = '.rst'
32
33# The encoding of source files.
34source_encoding = 'utf-8'
35
36# The master toctree document.
37master_doc = 'index'
38
39# General information about the project.
40repository_name = u'openstack/monasca-notification'
41project = u'Monasca Notification Engine Release Notes'
42
43# Release notes do not need a version number in the title, they
44# cover multiple releases.
45version = ''
46release = ''
47bug_project = 'monasca-notification'
48bug_tag = u''
49copyright = u'2014-present, OpenStack Foundation'
50author = u'OpenStack Foundation'
51
52# The language for content autogenerated by Sphinx. Refer to documentation
53# for a list of supported languages.
54# language = None
55
56# There are two options for replacing |today|: either, you set today to some
57# non-false value, then it is used:
58# today = ''
59# Else, today_fmt is used as the format for a strftime call.
60# today_fmt = '%B %d, %Y'
61
62# List of patterns, relative to source directory, that match files and
63# directories to ignore when looking for source files.
64exclude_patterns = []
65
66# The reST default role (used for this markup: `text`) to use for all
67# documents.
68# default_role = None
69
70# If true, '()' will be appended to :func: etc. cross-reference text.
71# add_function_parentheses = True
72
73# If true, the current module name will be prepended to all description
74# unit titles (such as .. function::).
75# add_module_names = True
76
77# If true, sectionauthor and moduleauthor directives will be shown in the
78# output. They are ignored by default.
79# show_authors = False
80
81# The name of the Pygments (syntax highlighting) style to use.
82pygments_style = 'sphinx'
83
84# A list of ignored prefixes for module index sorting.
85# modindex_common_prefix = []
86
87# If true, keep warnings as "system message" paragraphs in the built documents.
88# keep_warnings = False
89
90
91# -- Options for HTML output ----------------------------------------------
92
93# The theme to use for HTML and HTML Help pages. See the documentation for
94# a list of builtin themes.
95html_theme = 'openstackdocs'
96
97# Theme options are theme-specific and customize the look and feel of a theme
98# further. For a list of options available for each theme, see the
99# documentation.
100# html_theme_options = {}
101
102# Add any paths that contain custom themes here, relative to this directory.
103# html_theme_path = []
104
105# The name for this set of Sphinx documents. If None, it defaults to
106# "<project> v<release> documentation".
107# html_title = None
108
109# A shorter title for the navigation bar. Default is the same as html_title.
110# html_short_title = None
111
112# The name of an image file (relative to this directory) to place at the top
113# of the sidebar.
114# html_logo = None
115
116# The name of an image file (within the static path) to use as favicon of the
117# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
118# pixels large.
119# html_favicon = None
120
121# Add any paths that contain custom static files (such as style sheets) here,
122# relative to this directory. They are copied after the builtin static files,
123# so a file named "default.css" will overwrite the builtin "default.css".
124# html_static_path = []
125
126# Add any extra paths that contain custom files (such as robots.txt or
127# .htaccess) here, relative to this directory. These files are copied
128# directly to the root of the documentation.
129# html_extra_path = []
130
131# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132# using the given strftime format.
133html_last_updated_fmt = '%Y-%m-%d %H:%M'
134
135# If true, SmartyPants will be used to convert quotes and dashes to
136# typographically correct entities.
137# html_use_smartypants = True
138
139# Custom sidebar templates, maps document names to template names.
140# html_sidebars = {}
141
142# Additional templates that should be rendered to pages, maps page names to
143# template names.
144# html_additional_pages = {}
145
146# If false, no module index is generated.
147# html_domain_indices = True
148
149# If false, no index is generated.
150# html_use_index = True
151
152# If true, the index is split into individual pages for each letter.
153# html_split_index = False
154
155# If true, links to the reST sources are added to the pages.
156# html_show_sourcelink = True
157
158# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159# html_show_sphinx = True
160
161# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162# html_show_copyright = True
163
164# If true, an OpenSearch description file will be output, and all pages will
165# contain a <link> tag referring to it. The value of this option must be the
166# base URL from which the finished HTML is served.
167# html_use_opensearch = ''
168
169# This is the file name suffix for HTML files (e.g. ".xhtml").
170# html_file_suffix = None
171
172# Output file base name for HTML help builder.
173htmlhelp_basename = 'MonascaNotificationReleaseNotesdoc'
174
175# -- Options for LaTeX output ---------------------------------------------
176
177latex_elements = {
178 # The paper size ('letterpaper' or 'a4paper').
179 # 'papersize': 'letterpaper',
180
181 # The font size ('10pt', '11pt' or '12pt').
182 # 'pointsize': '10pt',
183
184 # Additional stuff for the LaTeX preamble.
185 # 'preamble': '',
186}
187
188# Grouping the document tree into LaTeX files. List of tuples
189# (source start file, target name, title,
190# author, documentclass [howto, manual, or own class]).
191
192latex_documents = [
193 ('index', 'MonascaNotificationNotes.tex', u'Monasca Notification Release Notes Documentation',
194 u'Monasca developers', 'manual'),
195]
196
197# The name of an image file (relative to this directory) to place at the top of
198# the title page.
199# latex_logo = None
200
201# For "manual" documents, if this is true, then toplevel headings are parts,
202# not chapters.
203# latex_use_parts = False
204
205# If true, show page references after internal links.
206# latex_show_pagerefs = False
207
208# If true, show URL addresses after external links.
209# latex_show_urls = False
210
211# Documents to append as an appendix to all manuals.
212# latex_appendices = []
213
214# If false, no module index is generated.
215# latex_domain_indices = True
216
217
218# -- Options for manual page output ---------------------------------------
219
220# One entry per manual page. List of tuples
221# (source start file, name, description, authors, manual section).
222
223man_pages = [
224 ('index', 'monascanotificationreleasenotes', u'Monasca Notification Release Notes Documentation',
225 [u'Monasca developers'], 1)
226]
227
228# -- Options for Internationalization output ------------------------------
229locale_dirs = ['locale/']
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 0000000..9b7edb3
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,21 @@
1..
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===================================
15 Monasca Notification Release Notes
16===================================
17
18.. toctree::
19 :maxdepth: 1
20
21 unreleased
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 0000000..cd22aab
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
1==============================
2 Current Series Release Notes
3==============================
4
5.. release-notes::
diff --git a/tox.ini b/tox.ini
index 33cd7f7..90601ce 100644
--- a/tox.ini
+++ b/tox.ini
@@ -84,3 +84,9 @@ deps =
84 -r{toxinidir}/test-requirements.txt 84 -r{toxinidir}/test-requirements.txt
85 -r{toxinidir}/requirements.txt 85 -r{toxinidir}/requirements.txt
86 .[jira_plugin] 86 .[jira_plugin]
87
88[testenv:releasenotes]
89deps = -r{toxinidir}/doc/requirements.txt
90commands =
91 sphinx-build -a -E -W -d releasenotes/build/doctrees -b html \
92 releasenotes/source releasenotes/build/html