summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Bourdon <obourdon@mirantis.com>2016-03-03 14:04:49 +0100
committerOlivier Bourdon <obourdon@mirantis.com>2016-03-03 14:04:49 +0100
commit8d9e030bfc8b2a87a26d6aaa94537535ea8ccc16 (patch)
treedd24a7473efd9e25c0474b4ddbcdf14da02db18e
parent277206f54052dc7cf8260de411e18a558a019357 (diff)
Add tox environments to build the plugin and docs
Notes
Notes (review): Code-Review+2: Swann Croiset <scroiset@mirantis.com> Code-Review+2: Olivier Bourdon <obourdon@mirantis.com> Workflow+1: Olivier Bourdon <obourdon@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 16 Mar 2016 16:45:29 +0000 Reviewed-on: https://review.openstack.org/287786 Project: openstack/fuel-plugin-zabbix-monitoring-emc Branch: refs/heads/master
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/plugin-guide/Makefile192
-rw-r--r--doc/plugin-guide/images/events.png (renamed from doc/images/events.png)bin47282 -> 47282 bytes
-rw-r--r--doc/plugin-guide/images/history.png (renamed from doc/images/history.png)bin58520 -> 58520 bytes
-rw-r--r--doc/plugin-guide/images/hosts.png (renamed from doc/images/hosts.png)bin37835 -> 37835 bytes
-rw-r--r--doc/plugin-guide/images/issues.png (renamed from doc/images/issues.png)bin27785 -> 27785 bytes
-rw-r--r--doc/plugin-guide/images/settings.png (renamed from doc/images/settings.png)bin14394 -> 14394 bytes
-rw-r--r--doc/plugin-guide/images/snmptrapd_settings.png (renamed from doc/images/snmptrapd_settings.png)bin12255 -> 12255 bytes
-rw-r--r--doc/plugin-guide/source/_static/.gitkeep0
-rw-r--r--doc/plugin-guide/source/appendix.rst (renamed from doc/content/appendix.rst)0
-rw-r--r--doc/plugin-guide/source/conf.py285
-rw-r--r--doc/plugin-guide/source/description.rst (renamed from doc/content/description.rst)0
-rw-r--r--doc/plugin-guide/source/guide.rst (renamed from doc/content/guide.rst)14
-rw-r--r--doc/plugin-guide/source/index.rst (renamed from doc/user_guide.rst)14
-rw-r--r--doc/plugin-guide/source/installation.rst (renamed from doc/content/installation.rst)2
-rw-r--r--doc/plugin-guide/source/terms.rst (renamed from doc/content/terms.rst)0
-rw-r--r--doc/specs/Makefile192
-rw-r--r--doc/specs/source/_static/.gitkeep0
-rw-r--r--doc/specs/source/conf.py285
-rw-r--r--doc/specs/source/index.rst (renamed from spec/zabbix-monitoring-emc-plugin-spec.rst)0
-rw-r--r--tox.ini12
21 files changed, 980 insertions, 17 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..567609b
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
build/
diff --git a/doc/plugin-guide/Makefile b/doc/plugin-guide/Makefile
new file mode 100644
index 0000000..7a69b5f
--- /dev/null
+++ b/doc/plugin-guide/Makefile
@@ -0,0 +1,192 @@
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8BUILDDIR = build
9
10# User-friendly check for sphinx-build
11ifeq ($(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/)
13endif
14
15# Internal variables.
16PAPEROPT_a4 = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS = $(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
24help:
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
51clean:
52 rm -rf $(BUILDDIR)/*
53
54html:
55 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56 @echo
57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
59dirhtml:
60 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61 @echo
62 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
64singlehtml:
65 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66 @echo
67 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
69pickle:
70 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71 @echo
72 @echo "Build finished; now you can process the pickle files."
73
74json:
75 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76 @echo
77 @echo "Build finished; now you can process the JSON files."
78
79htmlhelp:
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
85qthelp:
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/TheZabbixpluginforFuel.qhcp"
91 @echo "To view the help file:"
92 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.qhc"
93
94applehelp:
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
102devhelp:
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/TheZabbixpluginforFuel"
108 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
109 @echo "# devhelp"
110
111epub:
112 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113 @echo
114 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115
116latex:
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
123latexpdf:
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
129latexpdfja:
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
135text:
136 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137 @echo
138 @echo "Build finished. The text files are in $(BUILDDIR)/text."
139
140man:
141 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142 @echo
143 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144
145texinfo:
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
152info:
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
158gettext:
159 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160 @echo
161 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162
163changes:
164 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165 @echo
166 @echo "The overview file is in $(BUILDDIR)/changes."
167
168linkcheck:
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
174doctest:
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
179coverage:
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
184xml:
185 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186 @echo
187 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188
189pseudoxml:
190 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191 @echo
192 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc/images/events.png b/doc/plugin-guide/images/events.png
index 903db40..903db40 100644
--- a/doc/images/events.png
+++ b/doc/plugin-guide/images/events.png
Binary files differ
diff --git a/doc/images/history.png b/doc/plugin-guide/images/history.png
index 2f8bb42..2f8bb42 100644
--- a/doc/images/history.png
+++ b/doc/plugin-guide/images/history.png
Binary files differ
diff --git a/doc/images/hosts.png b/doc/plugin-guide/images/hosts.png
index 5052475..5052475 100644
--- a/doc/images/hosts.png
+++ b/doc/plugin-guide/images/hosts.png
Binary files differ
diff --git a/doc/images/issues.png b/doc/plugin-guide/images/issues.png
index befaaf7..befaaf7 100644
--- a/doc/images/issues.png
+++ b/doc/plugin-guide/images/issues.png
Binary files differ
diff --git a/doc/images/settings.png b/doc/plugin-guide/images/settings.png
index c333a1f..c333a1f 100644
--- a/doc/images/settings.png
+++ b/doc/plugin-guide/images/settings.png
Binary files differ
diff --git a/doc/images/snmptrapd_settings.png b/doc/plugin-guide/images/snmptrapd_settings.png
index 07dfce7..07dfce7 100644
--- a/doc/images/snmptrapd_settings.png
+++ b/doc/plugin-guide/images/snmptrapd_settings.png
Binary files differ
diff --git a/doc/plugin-guide/source/_static/.gitkeep b/doc/plugin-guide/source/_static/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/plugin-guide/source/_static/.gitkeep
diff --git a/doc/content/appendix.rst b/doc/plugin-guide/source/appendix.rst
index a816531..a816531 100644
--- a/doc/content/appendix.rst
+++ b/doc/plugin-guide/source/appendix.rst
diff --git a/doc/plugin-guide/source/conf.py b/doc/plugin-guide/source/conf.py
new file mode 100644
index 0000000..bdec76a
--- /dev/null
+++ b/doc/plugin-guide/source/conf.py
@@ -0,0 +1,285 @@
1# -*- coding: utf-8 -*-
2#
3# The Zabbix plugin for Fuel EMC hardware monitoring extension documentation build configuration file, created by
4# sphinx-quickstart on Tue Nov 3 10:53:03 2015.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15import sys
16import os
17import shlex
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
32extensions = [
33 'sphinx.ext.todo',
34]
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# The suffix(es) of source filenames.
40# You can specify multiple suffix as a list of string:
41# source_suffix = ['.rst', '.md']
42source_suffix = '.rst'
43
44# The encoding of source files.
45#source_encoding = 'utf-8-sig'
46
47# The master toctree document.
48master_doc = 'index'
49
50# General information about the project.
51project = u'The Zabbix plugin for Fuel EMC hardware monitoring extension'
52copyright = u'2016, Mirantis'
53author = u'Mirantis'
54
55# The version info for the project you're documenting, acts as replacement for
56# |version| and |release|, also used in various other places throughout the
57# built documents.
58#
59# The short X.Y version.
60version = '1.0'
61# The full version, including alpha/beta/rc tags.
62release = '1.0-1.0.1-1'
63
64# The language for content autogenerated by Sphinx. Refer to documentation
65# for a list of supported languages.
66#
67# This is also used if you do content translation via gettext catalogs.
68# Usually you set "language" from the command line for these cases.
69language = None
70
71# There are two options for replacing |today|: either, you set today to some
72# non-false value, then it is used:
73#today = ''
74# Else, today_fmt is used as the format for a strftime call.
75#today_fmt = '%B %d, %Y'
76
77# List of patterns, relative to source directory, that match files and
78# directories to ignore when looking for source files.
79exclude_patterns = []
80
81# The reST default role (used for this markup: `text`) to use for all
82# documents.
83#default_role = None
84
85# If true, '()' will be appended to :func: etc. cross-reference text.
86#add_function_parentheses = True
87
88# If true, the current module name will be prepended to all description
89# unit titles (such as .. function::).
90#add_module_names = True
91
92# If true, sectionauthor and moduleauthor directives will be shown in the
93# output. They are ignored by default.
94#show_authors = False
95
96# The name of the Pygments (syntax highlighting) style to use.
97pygments_style = 'sphinx'
98
99# A list of ignored prefixes for module index sorting.
100#modindex_common_prefix = []
101
102# If true, keep warnings as "system message" paragraphs in the built documents.
103#keep_warnings = False
104
105# If true, `todo` and `todoList` produce output, else they produce nothing.
106todo_include_todos = True
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.
113html_theme = 'classic'
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".
142html_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
153# If true, SmartyPants will be used to convert quotes and dashes to
154# typographically correct entities.
155#html_use_smartypants = True
156
157# Custom sidebar templates, maps document names to template names.
158#html_sidebars = {}
159
160# Additional templates that should be rendered to pages, maps page names to
161# template names.
162#html_additional_pages = {}
163
164# If false, no module index is generated.
165#html_domain_indices = True
166
167# If false, no index is generated.
168#html_use_index = True
169
170# If true, the index is split into individual pages for each letter.
171#html_split_index = False
172
173# If true, links to the reST sources are added to the pages.
174#html_show_sourcelink = True
175
176# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
177#html_show_sphinx = True
178
179# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
180#html_show_copyright = True
181
182# If true, an OpenSearch description file will be output, and all pages will
183# contain a <link> tag referring to it. The value of this option must be the
184# base URL from which the finished HTML is served.
185#html_use_opensearch = ''
186
187# This is the file name suffix for HTML files (e.g. ".xhtml").
188#html_file_suffix = None
189
190# Language to be used for generating the HTML full-text search index.
191# Sphinx supports the following languages:
192# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
193# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
194#html_search_language = 'en'
195
196# A dictionary with options for the search language support, empty by default.
197# Now only 'ja' uses this config value
198#html_search_options = {'type': 'default'}
199
200# The name of a javascript file (relative to the configuration directory) that
201# implements a search results scorer. If empty, the default will be used.
202#html_search_scorer = 'scorer.js'
203
204# Output file base name for HTML help builder.
205htmlhelp_basename = 'TheZabbixpluginforFuelEMCExtensiondoc'
206
207# -- Options for LaTeX output ---------------------------------------------
208
209latex_elements = {
210# The paper size ('letterpaper' or 'a4paper').
211#'papersize': 'letterpaper',
212
213# The font size ('10pt', '11pt' or '12pt').
214#'pointsize': '10pt',
215
216# Additional stuff for the LaTeX preamble.
217#'preamble': '',
218
219# Latex figure (float) alignment
220#'figure_align': 'htbp',
221}
222
223# Grouping the document tree into LaTeX files. List of tuples
224# (source start file, target name, title,
225# author, documentclass [howto, manual, or own class]).
226latex_documents = [
227 (master_doc, 'TheZabbixpluginforFuelEMCExtension.tex', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Documentation',
228 author, 'manual'),
229]
230
231# The name of an image file (relative to this directory) to place at the top of
232# the title page.
233#latex_logo = None
234
235# For "manual" documents, if this is true, then toplevel headings are parts,
236# not chapters.
237#latex_use_parts = False
238
239# If true, show page references after internal links.
240#latex_show_pagerefs = False
241
242# If true, show URL addresses after external links.
243#latex_show_urls = False
244
245# Documents to append as an appendix to all manuals.
246#latex_appendices = []
247
248# If false, no module index is generated.
249#latex_domain_indices = True
250
251
252# -- Options for manual page output ---------------------------------------
253
254# One entry per manual page. List of tuples
255# (source start file, name, description, authors, manual section).
256man_pages = [
257 (master_doc, 'thezabbixpluginforfuelEMCExtension', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Documentation',
258 [author], 1)
259]
260
261# If true, show URL addresses after external links.
262#man_show_urls = False
263
264
265# -- Options for Texinfo output -------------------------------------------
266
267# Grouping the document tree into Texinfo files. List of tuples
268# (source start file, target name, title, author,
269# dir menu entry, description, category)
270texinfo_documents = [
271 (master_doc, 'TheZabbixpluginforFuelEMCExtension', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Documentation',
272 author, 'TheZabbixpluginforFuelEMCExtension')
273]
274
275# Documents to append as an appendix to all manuals.
276#texinfo_appendices = []
277
278# If false, no module index is generated.
279#texinfo_domain_indices = True
280
281# How to display URL addresses: 'footnote', 'no', or 'inline'.
282#texinfo_show_urls = 'footnote'
283
284# If true, do not generate a @detailmenu in the "Top" node's menu.
285#texinfo_no_detailmenu = False
diff --git a/doc/content/description.rst b/doc/plugin-guide/source/description.rst
index dbf4d24..dbf4d24 100644
--- a/doc/content/description.rst
+++ b/doc/plugin-guide/source/description.rst
diff --git a/doc/content/guide.rst b/doc/plugin-guide/source/guide.rst
index d78cc5b..81704fa 100644
--- a/doc/content/guide.rst
+++ b/doc/plugin-guide/source/guide.rst
@@ -18,7 +18,7 @@ Environment configuration
18 choose *EMC hardware monitoring extension for Zabbix plugin*, select the 18 choose *EMC hardware monitoring extension for Zabbix plugin*, select the
19 plugin checkbox and optionally fill in *EMC hardware to monitor* parameter: 19 plugin checkbox and optionally fill in *EMC hardware to monitor* parameter:
20 20
21 .. image:: images/settings.png 21 .. image:: ../images/settings.png
22 :width: 100% 22 :width: 100%
23 23
24 When you add your hardware to the *EMC hardware to monitor* comma separated 24 When you add your hardware to the *EMC hardware to monitor* comma separated
@@ -54,7 +54,7 @@ To test if everything is configured properly, follow these steps:
54 54
55 It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI: 55 It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
56 56
57 .. image:: images/snmptrapd_settings.png 57 .. image:: ../images/snmptrapd_settings.png
58 :width: 100% 58 :width: 100%
59 59
60 *<zabbix_VIP_address>* 60 *<zabbix_VIP_address>*
@@ -80,20 +80,20 @@ To test if everything is configured properly, follow these steps:
80 Plugins Catalog <https://www.mirantis.com/products/ 80 Plugins Catalog <https://www.mirantis.com/products/
81 openstack-drivers-and-plugins/fuel-plugins/>`_): 81 openstack-drivers-and-plugins/fuel-plugins/>`_):
82 82
83 .. image:: images/issues.png 83 .. image:: ../images/issues.png
84 :width: 100% 84 :width: 100%
85 85
86 When you click on a date in the *Last change* column of one of the issues, 86 When you click on a date in the *Last change* column of one of the issues,
87 you will see the **Events** page with list of events with the same type: 87 you will see the **Events** page with list of events with the same type:
88 88
89 .. image:: images/events.png 89 .. image:: ../images/events.png
90 :width: 100% 90 :width: 100%
91 91
92 To see a full description of the event, you have to click on event’s 92 To see a full description of the event, you have to click on event’s
93 description and choose *History*, then you will see a **History** page with 93 description and choose *History*, then you will see a **History** page with
94 a full event description: 94 a full event description:
95 95
96 .. image:: images/history.png 96 .. image:: ../images/history.png
97 :width: 100% 97 :width: 100%
98 98
993. After clicking *Configuration* tab and selecting *Hosts* option, you will 993. After clicking *Configuration* tab and selecting *Hosts* option, you will
@@ -101,7 +101,7 @@ To test if everything is configured properly, follow these steps:
101 host for every hardware listed in the *EMC hardware to monitor* plugin 101 host for every hardware listed in the *EMC hardware to monitor* plugin
102 parameter: 102 parameter:
103 103
104 .. image:: images/hosts.png 104 .. image:: ../images/hosts.png
105 :width: 100% 105 :width: 100%
106 106
107Hardware setup 107Hardware setup
@@ -126,6 +126,6 @@ parameters on your hardware:
1262. SNMP community - set the same value as in the *SNMP community* parameter 1262. SNMP community - set the same value as in the *SNMP community* parameter
127 from the SNMP trap daemon for Zabbix plugin settings: 127 from the SNMP trap daemon for Zabbix plugin settings:
128 128
129 .. image:: images/snmptrapd_settings.png 129 .. image:: ../images/snmptrapd_settings.png
130 :width: 100% 130 :width: 100%
131 131
diff --git a/doc/user_guide.rst b/doc/plugin-guide/source/index.rst
index 69ffcbe..39ec1e5 100644
--- a/doc/user_guide.rst
+++ b/doc/plugin-guide/source/index.rst
@@ -5,10 +5,12 @@ Guide to the EMC hardware monitoring extension for Zabbix plugin
5This document provides instructions for installing, configuring and using EMC 5This document provides instructions for installing, configuring and using EMC
6hardware monitoring extension for Zabbix plugin. 6hardware monitoring extension for Zabbix plugin.
7 7
8.. contents:: 8.. toctree::
9.. include:: content/terms.rst 9 :maxdepth: 2
10.. include:: content/description.rst 10
11.. include:: content/installation.rst 11 terms.rst
12.. include:: content/guide.rst 12 description.rst
13.. include:: content/appendix.rst 13 installation.rst
14 guide.rst
15 appendix.rst
14 16
diff --git a/doc/content/installation.rst b/doc/plugin-guide/source/installation.rst
index e110ac9..060539f 100644
--- a/doc/content/installation.rst
+++ b/doc/plugin-guide/source/installation.rst
@@ -17,7 +17,7 @@ steps:
173. Download the EMC hardware monitoring extension for Zabbix plugin from the 173. Download the EMC hardware monitoring extension for Zabbix plugin from the
18 `Fuel Plugins Catalog <https://www.mirantis.com/products/ 18 `Fuel Plugins Catalog <https://www.mirantis.com/products/
19 openstack-drivers-and-plugins/fuel-plugins/>`_. 19 openstack-drivers-and-plugins/fuel-plugins/>`_.
204. Copy the plugin on already installed Fuel Master node; ssh can be used for 204. Copy the plugin on already installed Fuel Master node, ssh can be used for
21 that. If you do not have the Fuel Master node yet, see `Quick Start Guide 21 that. If you do not have the Fuel Master node yet, see `Quick Start Guide
22 <https://software.mirantis.com/quick-start/>`_:: 22 <https://software.mirantis.com/quick-start/>`_::
23 23
diff --git a/doc/content/terms.rst b/doc/plugin-guide/source/terms.rst
index bcdf319..bcdf319 100644
--- a/doc/content/terms.rst
+++ b/doc/plugin-guide/source/terms.rst
diff --git a/doc/specs/Makefile b/doc/specs/Makefile
new file mode 100644
index 0000000..7a69b5f
--- /dev/null
+++ b/doc/specs/Makefile
@@ -0,0 +1,192 @@
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8BUILDDIR = build
9
10# User-friendly check for sphinx-build
11ifeq ($(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/)
13endif
14
15# Internal variables.
16PAPEROPT_a4 = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS = $(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
24help:
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
51clean:
52 rm -rf $(BUILDDIR)/*
53
54html:
55 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56 @echo
57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
59dirhtml:
60 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61 @echo
62 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
64singlehtml:
65 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66 @echo
67 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
69pickle:
70 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71 @echo
72 @echo "Build finished; now you can process the pickle files."
73
74json:
75 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76 @echo
77 @echo "Build finished; now you can process the JSON files."
78
79htmlhelp:
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
85qthelp:
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/TheZabbixpluginforFuel.qhcp"
91 @echo "To view the help file:"
92 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.qhc"
93
94applehelp:
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
102devhelp:
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/TheZabbixpluginforFuel"
108 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
109 @echo "# devhelp"
110
111epub:
112 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113 @echo
114 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115
116latex:
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
123latexpdf:
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
129latexpdfja:
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
135text:
136 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137 @echo
138 @echo "Build finished. The text files are in $(BUILDDIR)/text."
139
140man:
141 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142 @echo
143 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144
145texinfo:
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
152info:
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
158gettext:
159 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160 @echo
161 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162
163changes:
164 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165 @echo
166 @echo "The overview file is in $(BUILDDIR)/changes."
167
168linkcheck:
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
174doctest:
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
179coverage:
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
184xml:
185 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186 @echo
187 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188
189pseudoxml:
190 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191 @echo
192 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc/specs/source/_static/.gitkeep b/doc/specs/source/_static/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/specs/source/_static/.gitkeep
diff --git a/doc/specs/source/conf.py b/doc/specs/source/conf.py
new file mode 100644
index 0000000..8472bd8
--- /dev/null
+++ b/doc/specs/source/conf.py
@@ -0,0 +1,285 @@
1# -*- coding: utf-8 -*-
2#
3# The Zabbix plugin for Fuel EMC hardware monitoring extension specification documentation build configuration file, created by
4# sphinx-quickstart on Tue Nov 3 10:53:03 2015.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15import sys
16import os
17import shlex
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
32extensions = [
33 'sphinx.ext.todo',
34]
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# The suffix(es) of source filenames.
40# You can specify multiple suffix as a list of string:
41# source_suffix = ['.rst', '.md']
42source_suffix = '.rst'
43
44# The encoding of source files.
45#source_encoding = 'utf-8-sig'
46
47# The master toctree document.
48master_doc = 'index'
49
50# General information about the project.
51project = u'The Zabbix plugin for Fuel EMC hardware monitoring extension specification'
52copyright = u'2016, Mirantis'
53author = u'Mirantis'
54
55# The version info for the project you're documenting, acts as replacement for
56# |version| and |release|, also used in various other places throughout the
57# built documents.
58#
59# The short X.Y version.
60version = '1.0'
61# The full version, including alpha/beta/rc tags.
62release = '1.0-1.0.1-1'
63
64# The language for content autogenerated by Sphinx. Refer to documentation
65# for a list of supported languages.
66#
67# This is also used if you do content translation via gettext catalogs.
68# Usually you set "language" from the command line for these cases.
69language = None
70
71# There are two options for replacing |today|: either, you set today to some
72# non-false value, then it is used:
73#today = ''
74# Else, today_fmt is used as the format for a strftime call.
75#today_fmt = '%B %d, %Y'
76
77# List of patterns, relative to source directory, that match files and
78# directories to ignore when looking for source files.
79exclude_patterns = []
80
81# The reST default role (used for this markup: `text`) to use for all
82# documents.
83#default_role = None
84
85# If true, '()' will be appended to :func: etc. cross-reference text.
86#add_function_parentheses = True
87
88# If true, the current module name will be prepended to all description
89# unit titles (such as .. function::).
90#add_module_names = True
91
92# If true, sectionauthor and moduleauthor directives will be shown in the
93# output. They are ignored by default.
94#show_authors = False
95
96# The name of the Pygments (syntax highlighting) style to use.
97pygments_style = 'sphinx'
98
99# A list of ignored prefixes for module index sorting.
100#modindex_common_prefix = []
101
102# If true, keep warnings as "system message" paragraphs in the built documents.
103#keep_warnings = False
104
105# If true, `todo` and `todoList` produce output, else they produce nothing.
106todo_include_todos = True
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.
113html_theme = 'classic'
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".
142html_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
153# If true, SmartyPants will be used to convert quotes and dashes to
154# typographically correct entities.
155#html_use_smartypants = True
156
157# Custom sidebar templates, maps document names to template names.
158#html_sidebars = {}
159
160# Additional templates that should be rendered to pages, maps page names to
161# template names.
162#html_additional_pages = {}
163
164# If false, no module index is generated.
165#html_domain_indices = True
166
167# If false, no index is generated.
168#html_use_index = True
169
170# If true, the index is split into individual pages for each letter.
171#html_split_index = False
172
173# If true, links to the reST sources are added to the pages.
174#html_show_sourcelink = True
175
176# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
177#html_show_sphinx = True
178
179# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
180#html_show_copyright = True
181
182# If true, an OpenSearch description file will be output, and all pages will
183# contain a <link> tag referring to it. The value of this option must be the
184# base URL from which the finished HTML is served.
185#html_use_opensearch = ''
186
187# This is the file name suffix for HTML files (e.g. ".xhtml").
188#html_file_suffix = None
189
190# Language to be used for generating the HTML full-text search index.
191# Sphinx supports the following languages:
192# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
193# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
194#html_search_language = 'en'
195
196# A dictionary with options for the search language support, empty by default.
197# Now only 'ja' uses this config value
198#html_search_options = {'type': 'default'}
199
200# The name of a javascript file (relative to the configuration directory) that
201# implements a search results scorer. If empty, the default will be used.
202#html_search_scorer = 'scorer.js'
203
204# Output file base name for HTML help builder.
205htmlhelp_basename = 'TheZabbixpluginforFuelEMCExtensionSpecificationdoc'
206
207# -- Options for LaTeX output ---------------------------------------------
208
209latex_elements = {
210# The paper size ('letterpaper' or 'a4paper').
211#'papersize': 'letterpaper',
212
213# The font size ('10pt', '11pt' or '12pt').
214#'pointsize': '10pt',
215
216# Additional stuff for the LaTeX preamble.
217#'preamble': '',
218
219# Latex figure (float) alignment
220#'figure_align': 'htbp',
221}
222
223# Grouping the document tree into LaTeX files. List of tuples
224# (source start file, target name, title,
225# author, documentclass [howto, manual, or own class]).
226latex_documents = [
227 (master_doc, 'TheZabbixpluginforFuelEMCExtensionSpecification.tex', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Specification Documentation',
228 author, 'manual'),
229]
230
231# The name of an image file (relative to this directory) to place at the top of
232# the title page.
233#latex_logo = None
234
235# For "manual" documents, if this is true, then toplevel headings are parts,
236# not chapters.
237#latex_use_parts = False
238
239# If true, show page references after internal links.
240#latex_show_pagerefs = False
241
242# If true, show URL addresses after external links.
243#latex_show_urls = False
244
245# Documents to append as an appendix to all manuals.
246#latex_appendices = []
247
248# If false, no module index is generated.
249#latex_domain_indices = True
250
251
252# -- Options for manual page output ---------------------------------------
253
254# One entry per manual page. List of tuples
255# (source start file, name, description, authors, manual section).
256man_pages = [
257 (master_doc, 'thezabbixpluginforfuelEMCExtensionSpecification', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Specification Documentation',
258 [author], 1)
259]
260
261# If true, show URL addresses after external links.
262#man_show_urls = False
263
264
265# -- Options for Texinfo output -------------------------------------------
266
267# Grouping the document tree into Texinfo files. List of tuples
268# (source start file, target name, title, author,
269# dir menu entry, description, category)
270texinfo_documents = [
271 (master_doc, 'TheZabbixpluginforFuelEMCExtensionSpecification', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Specification Documentation',
272 author, 'TheZabbixpluginforFuelEMCExtensionSpecification')
273]
274
275# Documents to append as an appendix to all manuals.
276#texinfo_appendices = []
277
278# If false, no module index is generated.
279#texinfo_domain_indices = True
280
281# How to display URL addresses: 'footnote', 'no', or 'inline'.
282#texinfo_show_urls = 'footnote'
283
284# If true, do not generate a @detailmenu in the "Top" node's menu.
285#texinfo_no_detailmenu = False
diff --git a/spec/zabbix-monitoring-emc-plugin-spec.rst b/doc/specs/source/index.rst
index 816ee66..816ee66 100644
--- a/spec/zabbix-monitoring-emc-plugin-spec.rst
+++ b/doc/specs/source/index.rst
diff --git a/tox.ini b/tox.ini
index 25081fd..586dfb3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
1[tox] 1[tox]
2envlist = manifests,plugin_zabbix_monitoring_emc,build_plugin 2envlist = manifests,plugin_zabbix_monitoring_emc,build_plugin,docs,spec_docs
3skipsdist = True 3skipsdist = True
4 4
5[testenv] 5[testenv]
@@ -38,14 +38,20 @@ commands =
38 fpb --check {toxinidir} --debug 38 fpb --check {toxinidir} --debug
39 fpb --build {toxinidir} --debug 39 fpb --build {toxinidir} --debug
40 40
41[testenv:spec_docs]
42changedir = {toxinidir}/doc/specs
43whitelist_externals = make
44commands =
45 make clean html singlehtml SPHINXOPTS=-W
46
41[testenv:docs] 47[testenv:docs]
42changedir = {toxinidir}/doc/plugin-guide 48changedir = {toxinidir}/doc/plugin-guide
43whitelist_externals = make 49whitelist_externals = make
44commands = 50commands =
45 make clean html SPHINXOPTS=-W 51 make clean html singlehtml SPHINXOPTS=-W
46 52
47[testenv:qa_docs] 53[testenv:qa_docs]
48changedir = {toxinidir}/doc/qa 54changedir = {toxinidir}/doc/qa
49whitelist_externals = make 55whitelist_externals = make
50commands = 56commands =
51 make clean html SPHINXOPTS=-W 57 make clean html singlehtml SPHINXOPTS=-W