From 4fec0439df45a7e6df0ac5367f186c89dc646a5d Mon Sep 17 00:00:00 2001 From: Nadya Shakhat Date: Wed, 15 Jun 2016 14:30:39 +0300 Subject: [PATCH] Add Sphinx support Change-Id: I319153708e1193d9087158a163a460015cef530d --- .gitignore | 2 + doc/.gitignore | 2 + doc/Makefile | 191 ++++++++++++++++++ doc/content/tests.rst | 0 doc/source/conf.py | 32 +++ doc/{content => source}/description.rst | 3 - doc/{content => source}/guide.rst | 11 +- .../images/redis-plugin-8.0.png | Bin .../images/redis-plugin-on.png | Bin .../images/redis-plugin-on8.0.png | Bin .../images/redis-plugin.png | Bin doc/source/index.rst | 15 ++ doc/{content => source}/installation.rst | 3 +- test-requirements.txt | 4 + tox.ini | 18 ++ 15 files changed, 271 insertions(+), 10 deletions(-) create mode 100644 .gitignore create mode 100644 doc/.gitignore create mode 100644 doc/Makefile delete mode 100644 doc/content/tests.rst create mode 100644 doc/source/conf.py rename doc/{content => source}/description.rst (98%) rename doc/{content => source}/guide.rst (86%) rename doc/{content => source}/images/redis-plugin-8.0.png (100%) rename doc/{content => source}/images/redis-plugin-on.png (100%) rename doc/{content => source}/images/redis-plugin-on8.0.png (100%) rename doc/{content => source}/images/redis-plugin.png (100%) create mode 100644 doc/source/index.rst rename doc/{content => source}/installation.rst (93%) create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fba73ee --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.build/ +.tox diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..8d60ee6 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +build/ +images/*.pdf diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..5cad1b5 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,191 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(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/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# SVG to PDF conversion +SVG2PDF = inkscape +SVG2PDF_FLAGS = +# Build a list of SVG files to convert to PDF +PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg))) + + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + rm -f $(PDF_FILES) + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LMAcollector.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LMAcollector.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/LMAcollector" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LMAcollector" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: $(PDF_FILES) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: $(PDF_FILES) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +# Rule for building the PDF files only +images: $(PDF_FILES) + +# Pattern rule for converting SVG to PDF +%.pdf : %.svg + $(SVG2PDF) -f $< -A $@ diff --git a/doc/content/tests.rst b/doc/content/tests.rst deleted file mode 100644 index e69de29..0000000 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..9909511 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,32 @@ +import sys +import os +extensions = [] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +project = u'The Redis Plugin for Ceilometer documentation' +copyright = u'2016, Mirantis Inc.' +version = '0.1' +release = '0.1.0' +exclude_patterns = [ +] +pygments_style = 'sphinx' +html_theme = 'default' +htmlhelp_basename = 'RedisPlugindoc' +latex_elements = { +} +latex_documents = [ + ('index', 'RedisPlugindoc.tex', u'The Redis Plugin for Ceilometer documentation', + u'Mirantis Inc.', 'manual'), +] +man_pages = [ + ('index', 'redisplugin', u'The Redis Plugin for Ceilometer documentation', + [u'Mirantis Inc.'], 1) +] +texinfo_documents = [ + ('index', 'RedisPlugin', u'The Redis Plugin for Ceilometer documentation', + u'Mirantis Inc.', 'RedisPlugin', 'One line description of project.', + 'Miscellaneous'), +] +latex_elements = {'classoptions': ',openany,oneside', 'babel': + '\\usepackage[english]{babel}'} diff --git a/doc/content/description.rst b/doc/source/description.rst similarity index 98% rename from doc/content/description.rst rename to doc/source/description.rst index e30636c..1ea9019 100644 --- a/doc/content/description.rst +++ b/doc/source/description.rst @@ -73,7 +73,4 @@ Limitations ceilometer's pipeline.yaml. Thus, you need to configure it manually if you want to use transformers. If you don't need this feature, it is recommended to disable coordination for the notification agents. -.. include:: installation.rst -.. include:: guide.rst - diff --git a/doc/content/guide.rst b/doc/source/guide.rst similarity index 86% rename from doc/content/guide.rst rename to doc/source/guide.rst index f394c16..bbf089e 100644 --- a/doc/content/guide.rst +++ b/doc/source/guide.rst @@ -1,7 +1,7 @@ User Guide ========== -Once the Ceilometer Redis plugin plugin has been installed (following `Installation Guide`_), you can +Once the Ceilometer Redis plugin plugin has been installed (following :ref:`Installation Guide`), you can create *OpenStack* environments with Ceilometer whose Central agents, Notification agent and Alarm evaluator work in workload_partitioned mode. @@ -29,8 +29,7 @@ Plugin configuration in MOS 8.0 .. image:: images/redis-plugin-8.0.png :width: 100% -#. When - `adding nodes to environment and assigning roles to them `_, please consider using odd number of controllers as mentioned in `Limitations`_. +#. When adding nodes to environment and assigning roles to them `_, please consider using odd number of controllers as mentioned in :ref:`Limitations`. #. Finish `environment configuration `_ @@ -55,12 +54,12 @@ Plugin configuration in MOS 7.0 :width: 100% #. When - `adding nodes to environment and assigning roles to them `_, please consider using odd number of controllers as mentioned in `Limitations`_. + `adding nodes to environment and assigning roles to them in MOS 7.0 `_, please consider using odd number of controllers as mentioned in :ref:`Limitations`. #. Finish - `environment configuration `_ + `environment configuration for MOS 7.0 `_ -#. Run `network verification check `_. +#. Run `network verification check for MOS 7.0 `_. #. Press `Deploy button `_ to once you are done with environment configuration. diff --git a/doc/content/images/redis-plugin-8.0.png b/doc/source/images/redis-plugin-8.0.png similarity index 100% rename from doc/content/images/redis-plugin-8.0.png rename to doc/source/images/redis-plugin-8.0.png diff --git a/doc/content/images/redis-plugin-on.png b/doc/source/images/redis-plugin-on.png similarity index 100% rename from doc/content/images/redis-plugin-on.png rename to doc/source/images/redis-plugin-on.png diff --git a/doc/content/images/redis-plugin-on8.0.png b/doc/source/images/redis-plugin-on8.0.png similarity index 100% rename from doc/content/images/redis-plugin-on8.0.png rename to doc/source/images/redis-plugin-on8.0.png diff --git a/doc/content/images/redis-plugin.png b/doc/source/images/redis-plugin.png similarity index 100% rename from doc/content/images/redis-plugin.png rename to doc/source/images/redis-plugin.png diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..fe347f9 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,15 @@ +======================================================================== +Welcome to the Ceilometer Redis Plugin Documentation! +======================================================================== + +.. toctree:: + :maxdepth: 2 + + description + guide + installation + +Indices and Tables +================== + +* :ref:`search` diff --git a/doc/content/installation.rst b/doc/source/installation.rst similarity index 93% rename from doc/content/installation.rst rename to doc/source/installation.rst index fcbe272..53f3d6e 100644 --- a/doc/content/installation.rst +++ b/doc/source/installation.rst @@ -1,3 +1,4 @@ +.. _installation guide: Installation Guide ================== @@ -7,7 +8,7 @@ Install the Plugin To install the Redis plugin: -#. Please refer to `Limitations`_ before you proceed. +#. Please refer to limitations before you proceed. #. Download the Redis plugin from the `Fuel Plugins Catalog `_. diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..70e5d0a --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,4 @@ +-e git+https://github.com/openstack/fuel-plugins.git#egg=fuel-plugin-builder +Sphinx +# Hacking already pins down pep8, pyflakes and flake8 +hacking<0.11,>=0.10.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..de76db2 --- /dev/null +++ b/tox.ini @@ -0,0 +1,18 @@ +[tox] +envlist = docs +skipsdist = True + +[testenv] +deps = -r{toxinidir}/test-requirements.txt +passenv = HOME + +[flake8] +ignore = H105,H201,E241,H401 +show-source = True + +[testenv:docs] +changedir = {toxinidir}/doc +whitelist_externals = make +commands = + make clean html SPHINXOPTS=-W +