Browse Source

Implement OpenStack gate for monitorstack

This patch configures the monitorstack repository to work well with
the OSA gate jobs for docs, release notes, and functional tests.

Change-Id: Ibacea5cdfab609c3724b434189a6efad4b1c6c35
Major Hayden 2 years ago
parent
commit
b616091eb9
No account linked to committer's email address

+ 4
- 0
.gitreview View File

@@ -0,0 +1,4 @@
1
+[gerrit]
2
+host=review.openstack.org
3
+port=29418
4
+project=openstack/monitorstack.git

+ 192
- 0
doc/Makefile View File

@@ -0,0 +1,192 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = build
9
+
10
+# User-friendly check for sphinx-build
11
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13
+endif
14
+
15
+# Internal variables.
16
+PAPEROPT_a4     = -D latex_paper_size=a4
17
+PAPEROPT_letter = -D latex_paper_size=letter
18
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19
+# the i18n builder cannot share the environment and doctrees with the others
20
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
+
22
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
23
+
24
+help:
25
+	@echo "Please use \`make <target>' where <target> is one of"
26
+	@echo "  html       to make standalone HTML files"
27
+	@echo "  dirhtml    to make HTML files named index.html in directories"
28
+	@echo "  singlehtml to make a single large HTML file"
29
+	@echo "  pickle     to make pickle files"
30
+	@echo "  json       to make JSON files"
31
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
32
+	@echo "  qthelp     to make HTML files and a qthelp project"
33
+	@echo "  applehelp  to make an Apple Help Book"
34
+	@echo "  devhelp    to make HTML files and a Devhelp project"
35
+	@echo "  epub       to make an epub"
36
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
38
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39
+	@echo "  text       to make text files"
40
+	@echo "  man        to make manual pages"
41
+	@echo "  texinfo    to make Texinfo files"
42
+	@echo "  info       to make Texinfo files and run them through makeinfo"
43
+	@echo "  gettext    to make PO message catalogs"
44
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
45
+	@echo "  xml        to make Docutils-native XML files"
46
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
47
+	@echo "  linkcheck  to check all external links for integrity"
48
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
49
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
50
+
51
+clean:
52
+	rm -rf $(BUILDDIR)/*
53
+
54
+html:
55
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56
+	@echo
57
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
+
59
+dirhtml:
60
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61
+	@echo
62
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
+
64
+singlehtml:
65
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66
+	@echo
67
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
+
69
+pickle:
70
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71
+	@echo
72
+	@echo "Build finished; now you can process the pickle files."
73
+
74
+json:
75
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76
+	@echo
77
+	@echo "Build finished; now you can process the JSON files."
78
+
79
+htmlhelp:
80
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81
+	@echo
82
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
83
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
84
+
85
+qthelp:
86
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87
+	@echo
88
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openstack-ansible.qhcp"
91
+	@echo "To view the help file:"
92
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openstack-ansible.qhc"
93
+
94
+applehelp:
95
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
96
+	@echo
97
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
98
+	@echo "N.B. You won't be able to view it unless you put it in" \
99
+	      "~/Library/Documentation/Help or install it in your application" \
100
+	      "bundle."
101
+
102
+devhelp:
103
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
104
+	@echo
105
+	@echo "Build finished."
106
+	@echo "To view the help file:"
107
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/openstack-ansible"
108
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openstack-ansible"
109
+	@echo "# devhelp"
110
+
111
+epub:
112
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113
+	@echo
114
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115
+
116
+latex:
117
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118
+	@echo
119
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
120
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
121
+	      "(use \`make latexpdf' here to do that automatically)."
122
+
123
+latexpdf:
124
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125
+	@echo "Running LaTeX files through pdflatex..."
126
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
127
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128
+
129
+latexpdfja:
130
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
131
+	@echo "Running LaTeX files through platex and dvipdfmx..."
132
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
133
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
134
+
135
+text:
136
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137
+	@echo
138
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
139
+
140
+man:
141
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142
+	@echo
143
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144
+
145
+texinfo:
146
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
147
+	@echo
148
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
149
+	@echo "Run \`make' in that directory to run these through makeinfo" \
150
+	      "(use \`make info' here to do that automatically)."
151
+
152
+info:
153
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154
+	@echo "Running Texinfo files through makeinfo..."
155
+	make -C $(BUILDDIR)/texinfo info
156
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
157
+
158
+gettext:
159
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160
+	@echo
161
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162
+
163
+changes:
164
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165
+	@echo
166
+	@echo "The overview file is in $(BUILDDIR)/changes."
167
+
168
+linkcheck:
169
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
170
+	@echo
171
+	@echo "Link check complete; look for any errors in the above output " \
172
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
173
+
174
+doctest:
175
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
176
+	@echo "Testing of doctests in the sources finished, look at the " \
177
+	      "results in $(BUILDDIR)/doctest/output.txt."
178
+
179
+coverage:
180
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
181
+	@echo "Testing of coverage in the sources finished, look at the " \
182
+	      "results in $(BUILDDIR)/coverage/python.txt."
183
+
184
+xml:
185
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186
+	@echo
187
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188
+
189
+pseudoxml:
190
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191
+	@echo
192
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 206
- 0
doc/source/conf.py View File

@@ -0,0 +1,206 @@
1
+#!/usr/bin/env python3
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
+# This file is execfile()d with the current directory set to its
16
+# containing dir.
17
+#
18
+# Note that not all possible configuration values are present in this
19
+# autogenerated file.
20
+#
21
+# All configuration values have a default; values that are commented out
22
+# serve to show the default.
23
+"""Docs config for monitorstck."""
24
+import os
25
+
26
+import openstackdocstheme
27
+
28
+import pbr.version
29
+
30
+# If extensions (or modules to document with autodoc) are in another directory,
31
+# add these directories to sys.path here. If the directory is relative to the
32
+# documentation root, use os.path.abspath to make it absolute, like shown here.
33
+#
34
+# import os
35
+# import sys
36
+# sys.path.insert(0, os.path.abspath('.'))
37
+
38
+
39
+# -- General configuration ------------------------------------------------
40
+
41
+# If your documentation needs a minimal Sphinx version, state it here.
42
+#
43
+# needs_sphinx = '1.0'
44
+
45
+# Add any Sphinx extension module names here, as strings. They can be
46
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
47
+# ones.
48
+extensions = [
49
+    'sphinx.ext.autodoc',
50
+    'oslosphinx',
51
+    'sphinxmark'
52
+]
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'monitorstack'
68
+copyright = u'2017, OpenStack-Ansible Contributors'
69
+author = u'OpenStack-Ansible Contributors'
70
+
71
+# The link to the browsable source code (for the left hand menu)
72
+oslosphinx_cgit_link = ('http://git.openstack.org/cgit/openstack'
73
+                        '/{0}'.format(project))
74
+
75
+# The version info for the project you're documenting, acts as replacement for
76
+# |version| and |release|, also used in various other places throughout the
77
+# built documents.
78
+#
79
+# The short X.Y version.
80
+version_info = pbr.version.VersionInfo(project)
81
+# The full version, including alpha/beta/rc tags.
82
+release = version_info.version_string_with_vcs()
83
+# The short X.Y version.
84
+version = version_info.canonical_version_string()
85
+
86
+# A few variables have to be set for the log-a-bug feature.
87
+#   giturl: The location of conf.py on Git. Must be set manually.
88
+#   gitsha: The SHA checksum of the bug description.
89
+#           Automatically extracted from git log.
90
+#   bug_tag: Tag for categorizing the bug. Must be set manually.
91
+# These variables are passed to the logabug code via html_context.
92
+giturl = ("http://git.openstack.org/cgit/openstack/{0}"
93
+          "/tree/doc/source").format(project)
94
+git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
95
+gitsha = os.popen(git_cmd).read().strip('\n')
96
+bug_project = project.lower()
97
+bug_title = "Documentation bug"
98
+html_context = {"gitsha": gitsha, "giturl": giturl,
99
+                "bug_tag": "docs", "bug_title": bug_title,
100
+                "bug_project": bug_project}
101
+
102
+# The language for content autogenerated by Sphinx. Refer to documentation
103
+# for a list of supported languages.
104
+#
105
+# This is also used if you do content translation via gettext catalogs.
106
+# Usually you set "language" from the command line for these cases.
107
+language = None
108
+
109
+# List of patterns, relative to source directory, that match files and
110
+# directories to ignore when looking for source files.
111
+# This patterns also effect to html_static_path and html_extra_path
112
+exclude_patterns = []
113
+
114
+# The name of the Pygments (syntax highlighting) style to use.
115
+pygments_style = 'sphinx'
116
+
117
+# If true, `todo` and `todoList` produce output, else they produce nothing.
118
+todo_include_todos = False
119
+
120
+
121
+# -- Options for HTML output ----------------------------------------------
122
+
123
+# The theme to use for HTML and HTML Help pages.  See the documentation for
124
+# a list of builtin themes.
125
+#
126
+html_theme = 'openstackdocs'
127
+
128
+# Theme options are theme-specific and customize the look and feel of a theme
129
+# further.  For a list of options available for each theme, see the
130
+# documentation.
131
+#
132
+# html_theme_options = {}
133
+
134
+# Add any paths that contain custom themes here, relative to this directory.
135
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
136
+
137
+
138
+# -- Options for HTMLHelp output ------------------------------------------
139
+
140
+# Output file base name for HTML help builder.
141
+htmlhelp_basename = 'monitorstackdoc'
142
+
143
+
144
+# -- Options for LaTeX output ---------------------------------------------
145
+
146
+latex_elements = {
147
+    # The paper size ('letterpaper' or 'a4paper').
148
+    #
149
+    # 'papersize': 'letterpaper',
150
+
151
+    # The font size ('10pt', '11pt' or '12pt').
152
+    #
153
+    # 'pointsize': '10pt',
154
+
155
+    # Additional stuff for the LaTeX preamble.
156
+    #
157
+    # 'preamble': '',
158
+
159
+    # Latex figure (float) alignment
160
+    #
161
+    # 'figure_align': 'htbp',
162
+}
163
+
164
+# Grouping the document tree into LaTeX files. List of tuples
165
+# (source start file, target name, title,
166
+#  author, documentclass [howto, manual, or own class]).
167
+latex_documents = [
168
+    (master_doc, 'monitorstack.tex', u'monitorstack Documentation',
169
+     u'OpenStack-Ansible Contributors', 'manual'),
170
+]
171
+
172
+
173
+# -- Options for manual page output ---------------------------------------
174
+
175
+# One entry per manual page. List of tuples
176
+# (source start file, name, description, authors, manual section).
177
+man_pages = [
178
+    (master_doc, 'monitorstack', u'monitorstack Documentation',
179
+     [author], 1)
180
+]
181
+
182
+
183
+# -- Options for Texinfo output -------------------------------------------
184
+
185
+# Grouping the document tree into Texinfo files. List of tuples
186
+# (source start file, target name, title, author,
187
+#  dir menu entry, description, category)
188
+texinfo_documents = [
189
+    (master_doc, 'monitorstack', u'monitorstack Documentation',
190
+     author, 'monitorstack', 'One line description of project.',
191
+     'Miscellaneous'),
192
+]
193
+
194
+
195
+watermark = os.popen("git branch --contains $(git rev-parse HEAD)\
196
+| awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
197
+if watermark == "":
198
+    watermark = "Pre-release"
199
+
200
+# -- Options for sphinxmark -----------------------------------------------
201
+sphinxmark_enable = True
202
+sphinxmark_div = 'docs-body'
203
+sphinxmark_image = 'text'
204
+sphinxmark_text = watermark
205
+sphinxmark_text_color = (128, 128, 128)
206
+sphinxmark_text_size = 70

+ 15
- 0
doc/source/index.rst View File

@@ -0,0 +1,15 @@
1
+Welcome to monitorstack's documentation!
2
+========================================
3
+
4
+.. toctree::
5
+   :maxdepth: 2
6
+   :caption: Contents:
7
+
8
+
9
+
10
+Indices and tables
11
+==================
12
+
13
+* :ref:`genindex`
14
+* :ref:`modindex`
15
+* :ref:`search`

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


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

@@ -0,0 +1,205 @@
1
+#!/usr/bin/env python3
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
+# This file is execfile()d with the current directory set to its
16
+# containing dir.
17
+#
18
+# Note that not all possible configuration values are present in this
19
+# autogenerated file.
20
+#
21
+# All configuration values have a default; values that are commented out
22
+# serve to show the default.
23
+"""Release notes for monitorstack."""
24
+import os
25
+
26
+import openstackdocstheme
27
+
28
+import pbr.version
29
+
30
+# If extensions (or modules to document with autodoc) are in another directory,
31
+# add these directories to sys.path here. If the directory is relative to the
32
+# documentation root, use os.path.abspath to make it absolute, like shown here.
33
+#
34
+# import os
35
+# import sys
36
+# sys.path.insert(0, os.path.abspath('.'))
37
+
38
+
39
+# -- General configuration ------------------------------------------------
40
+
41
+# If your documentation needs a minimal Sphinx version, state it here.
42
+#
43
+# needs_sphinx = '1.0'
44
+
45
+# Add any Sphinx extension module names here, as strings. They can be
46
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
47
+# ones.
48
+extensions = [
49
+    'oslosphinx',
50
+    'reno.sphinxext',
51
+]
52
+
53
+# Add any paths that contain templates here, relative to this directory.
54
+templates_path = ['_templates']
55
+
56
+# The suffix(es) of source filenames.
57
+# You can specify multiple suffix as a list of string:
58
+#
59
+# source_suffix = ['.rst', '.md']
60
+source_suffix = '.rst'
61
+
62
+# The master toctree document.
63
+master_doc = 'index'
64
+
65
+# General information about the project.
66
+project = u'monitorstack'
67
+copyright = u'2017, OpenStack-Ansible Contributors'
68
+author = u'OpenStack-Ansible Contributors'
69
+
70
+# The link to the browsable source code (for the left hand menu)
71
+oslosphinx_cgit_link = ('http://git.openstack.org/cgit/openstack'
72
+                        '/{0}'.format(project))
73
+
74
+# The version info for the project you're documenting, acts as replacement for
75
+# |version| and |release|, also used in various other places throughout the
76
+# built documents.
77
+#
78
+# The short X.Y version.
79
+version_info = pbr.version.VersionInfo(project)
80
+# The full version, including alpha/beta/rc tags.
81
+release = version_info.version_string_with_vcs()
82
+# The short X.Y version.
83
+version = version_info.canonical_version_string()
84
+
85
+# A few variables have to be set for the log-a-bug feature.
86
+#   giturl: The location of conf.py on Git. Must be set manually.
87
+#   gitsha: The SHA checksum of the bug description.
88
+#           Automatically extracted from git log.
89
+#   bug_tag: Tag for categorizing the bug. Must be set manually.
90
+# These variables are passed to the logabug code via html_context.
91
+giturl = ("http://git.openstack.org/cgit/openstack/{0}"
92
+          "/tree/doc/source").format(project)
93
+git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
94
+gitsha = os.popen(git_cmd).read().strip('\n')
95
+bug_project = project.lower()
96
+bug_title = "Documentation bug"
97
+html_context = {"gitsha": gitsha, "giturl": giturl,
98
+                "bug_tag": "docs", "bug_title": bug_title,
99
+                "bug_project": bug_project}
100
+
101
+# The language for content autogenerated by Sphinx. Refer to documentation
102
+# for a list of supported languages.
103
+#
104
+# This is also used if you do content translation via gettext catalogs.
105
+# Usually you set "language" from the command line for these cases.
106
+language = None
107
+
108
+# List of patterns, relative to source directory, that match files and
109
+# directories to ignore when looking for source files.
110
+# This patterns also effect to html_static_path and html_extra_path
111
+exclude_patterns = []
112
+
113
+# The name of the Pygments (syntax highlighting) style to use.
114
+pygments_style = 'sphinx'
115
+
116
+# If true, `todo` and `todoList` produce output, else they produce nothing.
117
+todo_include_todos = False
118
+
119
+
120
+# -- Options for HTML output ----------------------------------------------
121
+
122
+# The theme to use for HTML and HTML Help pages.  See the documentation for
123
+# a list of builtin themes.
124
+#
125
+html_theme = 'openstackdocs'
126
+
127
+# Theme options are theme-specific and customize the look and feel of a theme
128
+# further.  For a list of options available for each theme, see the
129
+# documentation.
130
+#
131
+# html_theme_options = {}
132
+
133
+# Add any paths that contain custom themes here, relative to this directory.
134
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
135
+
136
+
137
+# -- Options for HTMLHelp output ------------------------------------------
138
+
139
+# Output file base name for HTML help builder.
140
+htmlhelp_basename = 'monitorstackdoc'
141
+
142
+
143
+# -- Options for LaTeX output ---------------------------------------------
144
+
145
+latex_elements = {
146
+    # The paper size ('letterpaper' or 'a4paper').
147
+    #
148
+    # 'papersize': 'letterpaper',
149
+
150
+    # The font size ('10pt', '11pt' or '12pt').
151
+    #
152
+    # 'pointsize': '10pt',
153
+
154
+    # Additional stuff for the LaTeX preamble.
155
+    #
156
+    # 'preamble': '',
157
+
158
+    # Latex figure (float) alignment
159
+    #
160
+    # 'figure_align': 'htbp',
161
+}
162
+
163
+# Grouping the document tree into LaTeX files. List of tuples
164
+# (source start file, target name, title,
165
+#  author, documentclass [howto, manual, or own class]).
166
+latex_documents = [
167
+    (master_doc, 'monitorstack.tex', u'monitorstack Documentation',
168
+     u'OpenStack-Ansible Contributors', 'manual'),
169
+]
170
+
171
+
172
+# -- Options for manual page output ---------------------------------------
173
+
174
+# One entry per manual page. List of tuples
175
+# (source start file, name, description, authors, manual section).
176
+man_pages = [
177
+    (master_doc, 'monitorstack', u'monitorstack Documentation',
178
+     [author], 1)
179
+]
180
+
181
+
182
+# -- Options for Texinfo output -------------------------------------------
183
+
184
+# Grouping the document tree into Texinfo files. List of tuples
185
+# (source start file, target name, title, author,
186
+#  dir menu entry, description, category)
187
+texinfo_documents = [
188
+    (master_doc, 'monitorstack', u'monitorstack Documentation',
189
+     author, 'monitorstack', 'One line description of project.',
190
+     'Miscellaneous'),
191
+]
192
+
193
+
194
+watermark = os.popen("git branch --contains $(git rev-parse HEAD)\
195
+| awk -F/ '/stable/ {print $2}'").read().strip(' \n\t').capitalize()
196
+if watermark == "":
197
+    watermark = "Pre-release"
198
+
199
+# -- Options for sphinxmark -----------------------------------------------
200
+sphinxmark_enable = True
201
+sphinxmark_div = 'docs-body'
202
+sphinxmark_image = 'text'
203
+sphinxmark_text = watermark
204
+sphinxmark_text_color = (128, 128, 128)
205
+sphinxmark_text_size = 70

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

@@ -0,0 +1,8 @@
1
+================================
2
+ OpenStack-Ansible 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::

+ 14
- 3
setup.cfg View File

@@ -3,9 +3,9 @@ name = monitorstack
3 3
 summary = Monitoring plugins for OpenStack
4 4
 description-file =
5 5
     README.rst
6
-author = Major Hayden
7
-author-email = major@mhtx.net
8
-home-page = https://github.com/major/monitorstack
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://docs.openstack.org/developer/monitorstack
9 9
 classifier =
10 10
     Environment :: OpenStack
11 11
     Intended Audience :: Information Technology
@@ -19,6 +19,11 @@ classifier =
19 19
     Programming Language :: Python :: 3.4
20 20
     Programming Language :: Python :: 3.5
21 21
 
22
+[build_sphinx]
23
+all_files = 1
24
+build-dir = doc/build
25
+source-dir = doc/source
26
+
22 27
 [files]
23 28
 packages =
24 29
     monitorstack
@@ -26,3 +31,9 @@ packages =
26 31
 [entry_points]
27 32
 console_scripts =
28 33
     monitorstack = monitorstack.cli:cli
34
+
35
+[pbr]
36
+warnerrors = True
37
+
38
+[wheel]
39
+universal = 1

+ 16
- 1
test-requirements.txt View File

@@ -1,3 +1,18 @@
1
-mock>=2.0.0
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.
4
+bashate>=0.2 # Apache-2.0
5
+flake8<2.6.0,>=2.5.4 # MIT
6
+mock>=2.0  # BSD
7
+
8
+# this is required for the docs build jobs
9
+sphinx>=1.5.1 # BSD
10
+oslosphinx>=4.7.0 # Apache-2.0
11
+openstackdocstheme>=1.5.0 # Apache-2.0
12
+doc8 # Apache-2.0
13
+reno>=1.8.0 # Apache-2.0
14
+sphinxmark>=0.1.14 # Apache-2.0
15
+
16
+# Requirements from outside of OpenStack
2 17
 pytest
3 18
 tox

+ 41
- 1
tox.ini View File

@@ -2,15 +2,55 @@
2 2
 envlist = {pypy,pep8,py3pep8,py27,py33,py34,py35}
3 3
 
4 4
 [testenv]
5
+usedevelop = True
5 6
 deps =
6 7
     coverage
7 8
     -rrequirements.txt
8 9
     -rtest-requirements.txt
9
-setenv =
10
+passenv =
11
+    HOME
12
+    http_proxy
13
+    HTTP_PROXY
14
+    https_proxy
15
+    HTTPS_PROXY
16
+    no_proxy
17
+    NO_PROXY
18
+whitelist_externals =
19
+    bash
10 20
 commands =
21
+    /usr/bin/find . -type f -name "*.pyc" -delete
11 22
     coverage run -m pytest --capture=no --strict {posargs}
12 23
     coverage report -m --omit="*/test*"
13 24
 
25
+# environment used by the -infra templated docs job
26
+[testenv:venv]
27
+commands =
28
+    {posargs}
29
+
30
+[testenv:docs]
31
+commands=
32
+    bash -c "rm -rf doc/build"
33
+    doc8 doc
34
+    python setup.py build_sphinx
35
+
36
+[doc8]
37
+# Settings for doc8:
38
+extensions = .rst
39
+
40
+[testenv:releasenotes]
41
+commands =
42
+    sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
43
+
44
+[testenv:linters]
45
+deps =
46
+    {[testenv:pep8]deps}
47
+commands =
48
+    {[testenv:pep8]commands}
49
+
50
+[testenv:functional]
51
+commands =
52
+    {[testenv]commands}
53
+
14 54
 [testenv:pep8]
15 55
 deps =
16 56
     flake8

Loading…
Cancel
Save