Browse Source

Add Sphinx support

Change-Id: I319153708e1193d9087158a163a460015cef530d
Nadya Shakhat 2 years ago
parent
commit
4fec0439df

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
1
+.build/
2
+.tox

+ 2
- 0
doc/.gitignore View File

@@ -0,0 +1,2 @@
1
+build/
2
+images/*.pdf

+ 191
- 0
doc/Makefile View File

@@ -0,0 +1,191 @@
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
+# SVG to PDF conversion
22
+SVG2PDF       = inkscape
23
+SVG2PDF_FLAGS =
24
+# Build a list of SVG files to convert to PDF
25
+PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
26
+
27
+
28
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
29
+
30
+help:
31
+	@echo "Please use \`make <target>' where <target> is one of"
32
+	@echo "  html       to make standalone HTML files"
33
+	@echo "  dirhtml    to make HTML files named index.html in directories"
34
+	@echo "  singlehtml to make a single large HTML file"
35
+	@echo "  pickle     to make pickle files"
36
+	@echo "  json       to make JSON files"
37
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
38
+	@echo "  qthelp     to make HTML files and a qthelp project"
39
+	@echo "  devhelp    to make HTML files and a Devhelp project"
40
+	@echo "  epub       to make an epub"
41
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
42
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
43
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
44
+	@echo "  text       to make text files"
45
+	@echo "  man        to make manual pages"
46
+	@echo "  texinfo    to make Texinfo files"
47
+	@echo "  info       to make Texinfo files and run them through makeinfo"
48
+	@echo "  gettext    to make PO message catalogs"
49
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
50
+	@echo "  xml        to make Docutils-native XML files"
51
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
52
+	@echo "  linkcheck  to check all external links for integrity"
53
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
54
+
55
+clean:
56
+	rm -rf $(BUILDDIR)/*
57
+	rm -f $(PDF_FILES)
58
+
59
+html:
60
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
61
+	@echo
62
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
63
+
64
+dirhtml:
65
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
66
+	@echo
67
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
68
+
69
+singlehtml:
70
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
71
+	@echo
72
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
73
+
74
+pickle:
75
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76
+	@echo
77
+	@echo "Build finished; now you can process the pickle files."
78
+
79
+json:
80
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
81
+	@echo
82
+	@echo "Build finished; now you can process the JSON files."
83
+
84
+htmlhelp:
85
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
86
+	@echo
87
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
88
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
89
+
90
+qthelp:
91
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
92
+	@echo
93
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
94
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
95
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LMAcollector.qhcp"
96
+	@echo "To view the help file:"
97
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LMAcollector.qhc"
98
+
99
+devhelp:
100
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
101
+	@echo
102
+	@echo "Build finished."
103
+	@echo "To view the help file:"
104
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/LMAcollector"
105
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LMAcollector"
106
+	@echo "# devhelp"
107
+
108
+epub:
109
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
110
+	@echo
111
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
112
+
113
+latex: $(PDF_FILES)
114
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115
+	@echo
116
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
117
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
118
+	      "(use \`make latexpdf' here to do that automatically)."
119
+
120
+latexpdf: $(PDF_FILES)
121
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
122
+	@echo "Running LaTeX files through pdflatex..."
123
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
124
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
125
+
126
+latexpdfja:
127
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
128
+	@echo "Running LaTeX files through platex and dvipdfmx..."
129
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
130
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
131
+
132
+text:
133
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
134
+	@echo
135
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
136
+
137
+man:
138
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
139
+	@echo
140
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
141
+
142
+texinfo:
143
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144
+	@echo
145
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
146
+	@echo "Run \`make' in that directory to run these through makeinfo" \
147
+	      "(use \`make info' here to do that automatically)."
148
+
149
+info:
150
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
151
+	@echo "Running Texinfo files through makeinfo..."
152
+	make -C $(BUILDDIR)/texinfo info
153
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
154
+
155
+gettext:
156
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
157
+	@echo
158
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
159
+
160
+changes:
161
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
162
+	@echo
163
+	@echo "The overview file is in $(BUILDDIR)/changes."
164
+
165
+linkcheck:
166
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
167
+	@echo
168
+	@echo "Link check complete; look for any errors in the above output " \
169
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
170
+
171
+doctest:
172
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
173
+	@echo "Testing of doctests in the sources finished, look at the " \
174
+	      "results in $(BUILDDIR)/doctest/output.txt."
175
+
176
+xml:
177
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
178
+	@echo
179
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
180
+
181
+pseudoxml:
182
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
183
+	@echo
184
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
185
+
186
+# Rule for building the PDF files only
187
+images: $(PDF_FILES)
188
+
189
+# Pattern rule for converting SVG to PDF
190
+%.pdf : %.svg
191
+	$(SVG2PDF) -f $< -A $@

+ 0
- 0
doc/content/tests.rst View File


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

@@ -0,0 +1,32 @@
1
+import sys
2
+import os
3
+extensions = []
4
+templates_path = ['_templates']
5
+source_suffix = '.rst'
6
+master_doc = 'index'
7
+project = u'The Redis Plugin for Ceilometer documentation'
8
+copyright = u'2016, Mirantis Inc.'
9
+version = '0.1'
10
+release = '0.1.0'
11
+exclude_patterns = [
12
+]
13
+pygments_style = 'sphinx'
14
+html_theme = 'default'
15
+htmlhelp_basename = 'RedisPlugindoc'
16
+latex_elements = {
17
+}
18
+latex_documents = [
19
+  ('index', 'RedisPlugindoc.tex', u'The Redis Plugin for Ceilometer documentation',
20
+   u'Mirantis Inc.', 'manual'),
21
+]
22
+man_pages = [
23
+    ('index', 'redisplugin', u'The Redis Plugin for Ceilometer documentation',
24
+     [u'Mirantis Inc.'], 1)
25
+]
26
+texinfo_documents = [
27
+  ('index', 'RedisPlugin', u'The Redis Plugin for Ceilometer documentation',
28
+   u'Mirantis Inc.', 'RedisPlugin', 'One line description of project.',
29
+   'Miscellaneous'),
30
+]
31
+latex_elements = {'classoptions': ',openany,oneside', 'babel':
32
+                  '\\usepackage[english]{babel}'}

doc/content/description.rst → doc/source/description.rst View File

@@ -73,7 +73,4 @@ Limitations
73 73
   ceilometer's pipeline.yaml. Thus, you need to configure it manually if you want to use transformers.
74 74
   If you don't need this feature, it is recommended to disable coordination for the notification agents.
75 75
 
76
-.. include:: installation.rst
77
-.. include:: guide.rst
78
-
79 76
 

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

@@ -1,7 +1,7 @@
1 1
 User Guide
2 2
 ==========
3 3
 
4
-Once the Ceilometer Redis plugin plugin has been installed (following `Installation Guide`_), you can
4
+Once the Ceilometer Redis plugin plugin has been installed  (following :ref:`Installation Guide`), you can
5 5
 create *OpenStack* environments with Ceilometer whose Central agents, Notification agent and Alarm evaluator
6 6
 work in workload_partitioned mode.
7 7
 
@@ -29,8 +29,7 @@ Plugin configuration in MOS 8.0
29 29
    .. image:: images/redis-plugin-8.0.png
30 30
     :width: 100%
31 31
 
32
-#. When
33
-   `adding nodes to environment and assigning roles to them <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html#adding-redeploying-and-replacing-nodes>`_, please consider using odd number of controllers as mentioned in `Limitations`_.
32
+#. When adding nodes to environment and assigning roles to them <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html#adding-redeploying-and-replacing-nodes>`_, please consider using odd number of controllers as mentioned in :ref:`Limitations`.
34 33
 
35 34
 #. Finish
36 35
    `environment configuration <https://docs.mirantis.com/openstack/fuel/fuel-8.0/mos-planning-guide.html#fuel-reference-architecture-overview>`_
@@ -55,12 +54,12 @@ Plugin configuration in MOS 7.0
55 54
     :width: 100%
56 55
 
57 56
 #. When
58
-   `adding nodes to environment and assigning roles to them <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-ug>`_, please consider using odd number of controllers as mentioned in `Limitations`_.
57
+   `adding nodes to environment and assigning roles to them in MOS 7.0 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-ug>`_, please consider using odd number of controllers as mentioned in :ref:`Limitations`.
59 58
 
60 59
 #. Finish
61
-   `environment configuration <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment>`_
60
+   `environment configuration for MOS 7.0 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment>`_
62 61
 
63
-#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_.
62
+#. Run `network verification check for MOS 7.0 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_.
64 63
 
65 64
 #. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_ to once you are done with environment configuration.
66 65
 

doc/content/images/redis-plugin-8.0.png → doc/source/images/redis-plugin-8.0.png View File


doc/content/images/redis-plugin-on.png → doc/source/images/redis-plugin-on.png View File


doc/content/images/redis-plugin-on8.0.png → doc/source/images/redis-plugin-on8.0.png View File


doc/content/images/redis-plugin.png → doc/source/images/redis-plugin.png View File


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

@@ -0,0 +1,15 @@
1
+========================================================================
2
+Welcome to the Ceilometer Redis Plugin Documentation!
3
+========================================================================
4
+
5
+.. toctree::
6
+   :maxdepth: 2
7
+
8
+   description
9
+   guide
10
+   installation
11
+
12
+Indices and Tables
13
+==================
14
+
15
+* :ref:`search`

doc/content/installation.rst → doc/source/installation.rst View File

@@ -1,3 +1,4 @@
1
+.. _installation guide:
1 2
 
2 3
 Installation Guide
3 4
 ==================
@@ -7,7 +8,7 @@ Install the Plugin
7 8
 
8 9
 To install the Redis plugin:
9 10
 
10
-#. Please refer to `Limitations`_ before you proceed.
11
+#. Please refer to limitations before you proceed.
11 12
 
12 13
 #. Download the Redis plugin from the
13 14
    `Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.

+ 4
- 0
test-requirements.txt View File

@@ -0,0 +1,4 @@
1
+-e git+https://github.com/openstack/fuel-plugins.git#egg=fuel-plugin-builder
2
+Sphinx
3
+# Hacking already pins down pep8, pyflakes and flake8
4
+hacking<0.11,>=0.10.0

+ 18
- 0
tox.ini View File

@@ -0,0 +1,18 @@
1
+[tox]
2
+envlist = docs
3
+skipsdist = True
4
+
5
+[testenv]
6
+deps = -r{toxinidir}/test-requirements.txt
7
+passenv = HOME
8
+
9
+[flake8]
10
+ignore = H105,H201,E241,H401
11
+show-source = True
12
+
13
+[testenv:docs]
14
+changedir = {toxinidir}/doc
15
+whitelist_externals = make
16
+commands =
17
+    make clean html SPHINXOPTS=-W
18
+

Loading…
Cancel
Save