Browse Source

Add tox environments to build the plugin and docs

Change-Id: I9821a88802e8c8945433d8a13555d92d868f58e2
Olivier Bourdon 3 years ago
parent
commit
1e20ba77e8

+ 4
- 0
.gitignore View File

@@ -1,3 +1,7 @@
1
+Gemfile.lock
2
+.bundle/
3
+.bundled_gems/
4
+.tox/
1 5
 .build/
2 6
 *.noarch.rpm
3 7
 repositories/centos/*.rpm

+ 23
- 0
deployment_scripts/puppet/manifests/Gemfile View File

@@ -0,0 +1,23 @@
1
+# Copyright 2015 Mirantis, Inc.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#     http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+source 'https://rubygems.org'
15
+
16
+group :development, :test do
17
+  gem 'rake'
18
+  gem "puppet", ENV['PUPPET_VERSION'] || '~> 3.4.0'
19
+  gem 'puppetlabs_spec_helper'
20
+  # Need to use master branch of puppet-lint because of
21
+  # https://github.com/rodjek/puppet-lint/issues/355
22
+  gem 'puppet-lint', :git => 'https://github.com/rodjek/puppet-lint.git'
23
+end

+ 13
- 0
deployment_scripts/puppet/manifests/Rakefile View File

@@ -0,0 +1,13 @@
1
+require 'puppet-lint/tasks/puppet-lint'
2
+require 'puppet-syntax/tasks/puppet-syntax'
3
+
4
+PuppetLint.configuration.fail_on_warnings = true
5
+PuppetLint.configuration.send('disable_80chars')
6
+PuppetLint.configuration.send('disable_class_inherits_from_params_class')
7
+PuppetLint.configuration.send('disable_class_parameter_defaults')
8
+
9
+desc "Run lint, and syntax tests."
10
+task :test => [
11
+  :lint,
12
+  :syntax,
13
+]

+ 24
- 0
deployment_scripts/puppet/modules/plugin_zabbix_snmptrapd/Gemfile View File

@@ -0,0 +1,24 @@
1
+# Copyright 2015 Mirantis, Inc.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#     http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+source 'https://rubygems.org'
15
+
16
+group :development, :test do
17
+  gem 'rake'
18
+  gem "puppet", ENV['PUPPET_VERSION'] || '~> 3.4.0'
19
+  gem 'puppetlabs_spec_helper'
20
+  # Need to use master branch of puppet-lint because of
21
+  # https://github.com/rodjek/puppet-lint/issues/355
22
+  gem 'puppet-lint', :git => 'https://github.com/rodjek/puppet-lint.git'
23
+end
24
+

+ 17
- 0
deployment_scripts/puppet/modules/plugin_zabbix_snmptrapd/Rakefile View File

@@ -0,0 +1,17 @@
1
+require 'puppetlabs_spec_helper/rake_tasks'
2
+require 'puppet-lint/tasks/puppet-lint'
3
+require 'puppet-syntax/tasks/puppet-syntax'
4
+
5
+PuppetLint.configuration.fail_on_warnings = true
6
+PuppetLint.configuration.send('disable_80chars')
7
+PuppetLint.configuration.send('disable_class_inherits_from_params_class')
8
+PuppetLint.configuration.send('disable_class_parameter_defaults')
9
+PuppetLint.configuration.send('disable_autoloader_layout')
10
+
11
+desc "Run lint, and syntax and spec tests."
12
+task :test => [
13
+  :lint,
14
+  :syntax,
15
+  :spec,
16
+]
17
+

+ 3
- 3
deployment_scripts/puppet/modules/plugin_zabbix_snmptrapd/manifests/init.pp View File

@@ -36,9 +36,9 @@ class plugin_zabbix_snmptrapd {
36 36
   }
37 37
 
38 38
   firewall { '998 snmptrapd':
39
-    proto     => 'udp',
40
-    action    => 'accept',
41
-    port      => $server_port,
39
+    proto  => 'udp',
40
+    action => 'accept',
41
+    port   => $server_port,
42 42
   }
43 43
 
44 44
   # The following resource overwrites default initscript for snmptrapd.

+ 18
- 18
deployment_scripts/puppet/modules/plugin_zabbix_snmptrapd/manifests/snmptt.pp View File

@@ -34,30 +34,30 @@ class plugin_zabbix_snmptrapd::snmptt {
34 34
   }
35 35
 
36 36
   file { '/etc/snmp/snmptt.ini':
37
-    ensure   => present,
38
-    mode     => '0644',
39
-    owner    => 'root',
40
-    group    => 'root',
41
-    source   => 'puppet:///modules/plugin_zabbix_snmptrapd/snmptt.ini',
42
-    require  => Package['snmptt'],
43
-    notify   => Service['snmptt'],
37
+    ensure  => present,
38
+    mode    => '0644',
39
+    owner   => 'root',
40
+    group   => 'root',
41
+    source  => 'puppet:///modules/plugin_zabbix_snmptrapd/snmptt.ini',
42
+    require => Package['snmptt'],
43
+    notify  => Service['snmptt'],
44 44
   }
45 45
 
46 46
   file { '/etc/snmp/snmptt.conf':
47
-    ensure   => present,
48
-    mode     => '0644',
49
-    owner    => 'root',
50
-    group    => 'root',
51
-    source   => 'puppet:///modules/plugin_zabbix_snmptrapd/snmptt.conf',
52
-    require  => Package['snmptt'],
53
-    notify   => Service['snmptt'],
47
+    ensure  => present,
48
+    mode    => '0644',
49
+    owner   => 'root',
50
+    group   => 'root',
51
+    source  => 'puppet:///modules/plugin_zabbix_snmptrapd/snmptt.conf',
52
+    require => Package['snmptt'],
53
+    notify  => Service['snmptt'],
54 54
   }
55 55
 
56 56
   file_line { 'in logrotate disable compressing of snmptt logfiles':
57
-    path     => '/etc/logrotate.d/snmptt',
58
-    match    => 'compress',
59
-    line     => 'nocompress',
60
-    require  => Package['snmptt'],
57
+    path    => '/etc/logrotate.d/snmptt',
58
+    match   => 'compress',
59
+    line    => 'nocompress',
60
+    require => Package['snmptt'],
61 61
   }
62 62
 
63 63
 }

+ 1
- 1
deployment_scripts/puppet/modules/plugin_zabbix_snmptrapd/manifests/zabbix.pp View File

@@ -21,7 +21,7 @@ class plugin_zabbix_snmptrapd::zabbix {
21 21
     group   => 'root',
22 22
     mode    => '0644',
23 23
     content => template($plugin_zabbix_snmptrapd::params::server_snmp_config_template),
24
-    notify   => Service['p_zabbix-server'],
24
+    notify  => Service['p_zabbix-server'],
25 25
   }
26 26
 
27 27
   service { 'p_zabbix-server':

+ 1
- 0
doc/.gitignore View File

@@ -0,0 +1 @@
1
+build/

+ 192
- 0
doc/plugin-guide/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/TheZabbixpluginforFuel.qhcp"
91
+	@echo "To view the help file:"
92
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.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/TheZabbixpluginforFuel"
108
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
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."

doc/images/settings.png → doc/plugin-guide/images/settings.png View File


+ 0
- 0
doc/plugin-guide/source/_static/.gitkeep View File


doc/content/appendix.rst → doc/plugin-guide/source/appendix.rst View File


+ 285
- 0
doc/plugin-guide/source/conf.py View File

@@ -0,0 +1,285 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# The Zabbix SNMP Trapd plugin for Fuel 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
+
15
+import sys
16
+import os
17
+import 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.
32
+extensions = [
33
+    'sphinx.ext.todo',
34
+]
35
+
36
+# Add any paths that contain templates here, relative to this directory.
37
+templates_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']
42
+source_suffix = '.rst'
43
+
44
+# The encoding of source files.
45
+#source_encoding = 'utf-8-sig'
46
+
47
+# The master toctree document.
48
+master_doc = 'index'
49
+
50
+# General information about the project.
51
+project = u'The Zabbix SNMP Trapd plugin for Fuel'
52
+copyright = u'2016, Mirantis'
53
+author = 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.
60
+version = '1.0.1'
61
+# The full version, including alpha/beta/rc tags.
62
+release = '1.0.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.
69
+language = 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.
79
+exclude_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.
97
+pygments_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.
106
+todo_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.
113
+html_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".
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
+
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.
205
+htmlhelp_basename = 'TheZabbixSNMPTrapdpluginforFueldoc'
206
+
207
+# -- Options for LaTeX output ---------------------------------------------
208
+
209
+latex_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]).
226
+latex_documents = [
227
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel.tex', u'The Zabbix SNMP Trapd plugin for Fuel 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).
256
+man_pages = [
257
+    (master_doc, 'thezabbixsnmptrapdpluginforfuel', u'The Zabbix SNMP Trapd plugin for Fuel 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)
270
+texinfo_documents = [
271
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
272
+   author, 'TheZabbixSNMPTrapdpluginforFuel'),
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

doc/content/description.rst → doc/plugin-guide/source/description.rst View File


doc/content/guide.rst → doc/plugin-guide/source/guide.rst View File

@@ -15,7 +15,7 @@ Environment configuration
15 15
    choose *SNMP trap daemon for Zabbix plugin*, select the plugin checkbox and
16 16
    set *SNMP community* parameter:
17 17
 
18
-   .. image:: images/settings.png
18
+   .. image:: ../images/settings.png
19 19
       :width: 100%
20 20
 
21 21
    You could see default value by clicking on the eye icon. It is highly
@@ -52,7 +52,7 @@ To test if everything is installed and configured properly, follow these steps:
52 52
 
53 53
        It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
54 54
 
55
-   .. image:: images/settings.png
55
+   .. image:: ../images/settings.png
56 56
       :width: 100%
57 57
 
58 58
    *<zabbix_VIP_address>*

doc/user_guide.rst → doc/plugin-guide/source/index.rst View File

@@ -5,11 +5,13 @@ Guide to the SNMP trap daemon for Zabbix plugin
5 5
 This document provides instructions for installing, configuring and using
6 6
 SNMP trap daemon for Zabbix plugin.
7 7
 
8
-.. contents::
9
-.. include:: content/terms.rst
10
-.. include:: content/description.rst
11
-.. include:: content/installation.rst
12
-.. include:: content/guide.rst
13
-.. include:: content/appendix.rst
14
-.. include:: content/licenses.rst
8
+.. toctree::
9
+   :maxdepth: 2
10
+
11
+   terms.rst
12
+   description.rst
13
+   installation.rst
14
+   guide.rst
15
+   appendix.rst
16
+   licenses.rst
15 17
 

doc/content/installation.rst → doc/plugin-guide/source/installation.rst View File


doc/content/licenses.rst → doc/plugin-guide/source/licenses.rst View File


doc/content/terms.rst → doc/plugin-guide/source/terms.rst View File


+ 192
- 0
doc/qa/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/TheZabbixpluginforFuel.qhcp"
91
+	@echo "To view the help file:"
92
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.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/TheZabbixpluginforFuel"
108
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
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."

+ 0
- 0
doc/qa/source/_static/.gitkeep View File


+ 285
- 0
doc/qa/source/conf.py View File

@@ -0,0 +1,285 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# The Zabbix SNMP Trapd plugin for Fuel 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
+
15
+import sys
16
+import os
17
+import 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.
32
+extensions = [
33
+    'sphinx.ext.todo',
34
+]
35
+
36
+# Add any paths that contain templates here, relative to this directory.
37
+templates_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']
42
+source_suffix = '.rst'
43
+
44
+# The encoding of source files.
45
+#source_encoding = 'utf-8-sig'
46
+
47
+# The master toctree document.
48
+master_doc = 'index'
49
+
50
+# General information about the project.
51
+project = u'The Zabbix SNMP Trapd plugin for Fuel'
52
+copyright = u'2016, Mirantis'
53
+author = 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.
60
+version = '1.0.1'
61
+# The full version, including alpha/beta/rc tags.
62
+release = '1.0.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.
69
+language = 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.
79
+exclude_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.
97
+pygments_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.
106
+todo_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.
113
+html_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".
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
+
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.
205
+htmlhelp_basename = 'TheZabbixSNMPTrapdpluginforFueldoc'
206
+
207
+# -- Options for LaTeX output ---------------------------------------------
208
+
209
+latex_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]).
226
+latex_documents = [
227
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel.tex', u'The Zabbix SNMP Trapd plugin for Fuel 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).
256
+man_pages = [
257
+    (master_doc, 'thezabbixsnmptrapdpluginforfuel', u'The Zabbix SNMP Trapd plugin for Fuel 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)
270
+texinfo_documents = [
271
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
272
+   author, 'TheZabbixSNMPTrapdpluginforFuel'),
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

+ 9
- 0
doc/qa/source/index.rst View File

@@ -0,0 +1,9 @@
1
+***********************************************
2
+Guide to the SNMP trap daemon for Zabbix plugin
3
+***********************************************
4
+
5
+Test plan
6
+=========
7
+
8
+.. toctree::
9
+   :maxdepth: 2

+ 2
- 0
test-requirements.txt View File

@@ -0,0 +1,2 @@
1
+Sphinx
2
+fuel-plugin-builder>=2.0.4

+ 51
- 0
tox.ini View File

@@ -0,0 +1,51 @@
1
+[tox]
2
+envlist = manifests,plugin_zabbix_snmptrapd,build_plugin,docs,qa_docs
3
+skipsdist = True
4
+
5
+[testenv]
6
+deps = -r{toxinidir}/test-requirements.txt
7
+passenv = HOME
8
+
9
+[testenv:manifests]
10
+changedir = {toxinidir}/deployment_scripts/puppet/manifests
11
+whitelist_externals =
12
+    bundle
13
+    mkdir
14
+commands =
15
+    mkdir -p {toxinidir}/.bundled_gems
16
+    bundle install --path {toxinidir}/.bundled_gems
17
+    bundle exec rake test
18
+
19
+[testenv:plugin_zabbix_snmptrapd]
20
+changedir = {toxinidir}/deployment_scripts/puppet/modules/{envname}
21
+whitelist_externals =
22
+    bundle
23
+    mkdir
24
+commands =
25
+    mkdir -p {toxinidir}/.bundled_gems
26
+    bundle install --path {toxinidir}/.bundled_gems
27
+    bundle exec rake test
28
+
29
+[testenv:build_plugin]
30
+changedir = {toxinidir}
31
+whitelist_externals=
32
+    fpb
33
+    rm
34
+commands =
35
+    rm -rf .build
36
+    rm -rf repositories/ubuntu/*.deb
37
+    rm -rf repositories/centos/*.rpm
38
+    fpb --check {toxinidir} --debug
39
+    fpb --build {toxinidir} --debug
40
+
41
+[testenv:docs]
42
+changedir = {toxinidir}/doc/plugin-guide
43
+whitelist_externals = make
44
+commands =
45
+    make clean html SPHINXOPTS=-W
46
+
47
+[testenv:qa_docs]
48
+changedir = {toxinidir}/doc/qa
49
+whitelist_externals = make
50
+commands =
51
+    make clean html SPHINXOPTS=-W

Loading…
Cancel
Save