diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..05d96649a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,41 @@ +# sphinx build folder +_build + +# Compiled source # +################### +*.com +*.class +*.dll +*.exe +*.o +*.so + +# Packages # +############ +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Logs and databases # +###################### +*.log +*.sql +*.sqlite + +# OS generated files # +###################### +.DS_Store? +ehthumbs.db +Icon? +Thumbs.db + +# Editor backup files # +####################### +*~ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..2ada11092 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +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 " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @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)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +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." + +.PHONY: qthelp +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/Troposphere.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Troposphere.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Troposphere" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Troposphere" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(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)." + +.PHONY: latexpdf +latexpdf: + $(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." + +.PHONY: latexpdfja +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." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +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)." + +.PHONY: info +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." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +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." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..e4aa08b68 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +Sphinx documentation usage +========================== + + +How to output html documentation +-------------------------------- +Requirements: + + pip install sphinx + + cd doc/ + make html + +html documentation will be available in doc/_build/html + +Update documentation +-------------------- + sphinx-apidoc -o troposphere ../troposphere + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..fb65b0413 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,166 @@ +# -*- coding: utf-8 -*- +# +# Troposphere documentation build configuration file, created by +# sphinx-quickstart on Fri Nov 25 16:48:51 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../troposphere')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Troposphere' +copyright = u'2016, Mark Peek ' +author = u'Mark Peek ' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.9.0' +# The full version, including alpha/beta/rc tags. +release = u'1.9.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Tropospheredoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Troposphere.tex', u'Troposphere Documentation', + u'Mark Peek \\textless{}mark@peek.org\\textgreater{}', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'troposphere', u'Troposphere Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Troposphere', u'Troposphere Documentation', + author, 'Troposphere', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..79cdd1329 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,25 @@ +.. Troposphere documentation master file, created by + sphinx-quickstart on Fri Nov 25 16:48:51 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Troposphere's documentation! +======================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + troposphere/troposphere.rst + troposphere/troposphere.helpers.rst + troposphere/troposphere.openstack.rst + troposphere/modules.rst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..44c476f22 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,281 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :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. epub3 to make an epub3 + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over 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 + echo. coverage to run coverage check of the documentation if enabled + echo. dummy to check syntax errors of document sources + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 1>NUL 2>NUL +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Troposphere.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Troposphere.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "epub3" ( + %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +if "%1" == "dummy" ( + %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. Dummy builder generates no files. + goto end +) + +:end diff --git a/docs/troposphere/modules.rst b/docs/troposphere/modules.rst new file mode 100644 index 000000000..f87903665 --- /dev/null +++ b/docs/troposphere/modules.rst @@ -0,0 +1,7 @@ +troposphere +=========== + +.. toctree:: + :maxdepth: 4 + + troposphere diff --git a/docs/troposphere/troposphere.helpers.rst b/docs/troposphere/troposphere.helpers.rst new file mode 100644 index 000000000..2bb99ae3f --- /dev/null +++ b/docs/troposphere/troposphere.helpers.rst @@ -0,0 +1,22 @@ +troposphere.helpers package +=========================== + +Submodules +---------- + +troposphere.helpers.userdata module +----------------------------------- + +.. automodule:: troposphere.helpers.userdata + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: troposphere.helpers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/troposphere/troposphere.openstack.rst b/docs/troposphere/troposphere.openstack.rst new file mode 100644 index 000000000..55e20a162 --- /dev/null +++ b/docs/troposphere/troposphere.openstack.rst @@ -0,0 +1,38 @@ +troposphere.openstack package +============================= + +Submodules +---------- + +troposphere.openstack.heat module +--------------------------------- + +.. automodule:: troposphere.openstack.heat + :members: + :undoc-members: + :show-inheritance: + +troposphere.openstack.neutron module +------------------------------------ + +.. automodule:: troposphere.openstack.neutron + :members: + :undoc-members: + :show-inheritance: + +troposphere.openstack.nova module +--------------------------------- + +.. automodule:: troposphere.openstack.nova + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: troposphere.openstack + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/troposphere/troposphere.rst b/docs/troposphere/troposphere.rst new file mode 100644 index 000000000..ddf4cd109 --- /dev/null +++ b/docs/troposphere/troposphere.rst @@ -0,0 +1,422 @@ +troposphere package +=================== + +Subpackages +----------- + +.. toctree:: + + troposphere.helpers + troposphere.openstack + +Submodules +---------- + +troposphere.apigateway module +----------------------------- + +.. automodule:: troposphere.apigateway + :members: + :undoc-members: + :show-inheritance: + +troposphere.applicationautoscaling module +----------------------------------------- + +.. automodule:: troposphere.applicationautoscaling + :members: + :undoc-members: + :show-inheritance: + +troposphere.autoscaling module +------------------------------ + +.. automodule:: troposphere.autoscaling + :members: + :undoc-members: + :show-inheritance: + +troposphere.awslambda module +---------------------------- + +.. automodule:: troposphere.awslambda + :members: + :undoc-members: + :show-inheritance: + +troposphere.certificatemanager module +------------------------------------- + +.. automodule:: troposphere.certificatemanager + :members: + :undoc-members: + :show-inheritance: + +troposphere.cloudformation module +--------------------------------- + +.. automodule:: troposphere.cloudformation + :members: + :undoc-members: + :show-inheritance: + +troposphere.cloudfront module +----------------------------- + +.. automodule:: troposphere.cloudfront + :members: + :undoc-members: + :show-inheritance: + +troposphere.cloudtrail module +----------------------------- + +.. automodule:: troposphere.cloudtrail + :members: + :undoc-members: + :show-inheritance: + +troposphere.cloudwatch module +----------------------------- + +.. automodule:: troposphere.cloudwatch + :members: + :undoc-members: + :show-inheritance: + +troposphere.codecommit module +----------------------------- + +.. automodule:: troposphere.codecommit + :members: + :undoc-members: + :show-inheritance: + +troposphere.codedeploy module +----------------------------- + +.. automodule:: troposphere.codedeploy + :members: + :undoc-members: + :show-inheritance: + +troposphere.codepipeline module +------------------------------- + +.. automodule:: troposphere.codepipeline + :members: + :undoc-members: + :show-inheritance: + +troposphere.config module +------------------------- + +.. automodule:: troposphere.config + :members: + :undoc-members: + :show-inheritance: + +troposphere.constants module +---------------------------- + +.. automodule:: troposphere.constants + :members: + :undoc-members: + :show-inheritance: + +troposphere.datapipeline module +------------------------------- + +.. automodule:: troposphere.datapipeline + :members: + :undoc-members: + :show-inheritance: + +troposphere.directoryservice module +----------------------------------- + +.. automodule:: troposphere.directoryservice + :members: + :undoc-members: + :show-inheritance: + +troposphere.dynamodb module +--------------------------- + +.. automodule:: troposphere.dynamodb + :members: + :undoc-members: + :show-inheritance: + +troposphere.dynamodb2 module +---------------------------- + +.. automodule:: troposphere.dynamodb2 + :members: + :undoc-members: + :show-inheritance: + +troposphere.ec2 module +---------------------- + +.. automodule:: troposphere.ec2 + :members: + :undoc-members: + :show-inheritance: + +troposphere.ecr module +---------------------- + +.. automodule:: troposphere.ecr + :members: + :undoc-members: + :show-inheritance: + +troposphere.ecs module +---------------------- + +.. automodule:: troposphere.ecs + :members: + :undoc-members: + :show-inheritance: + +troposphere.efs module +---------------------- + +.. automodule:: troposphere.efs + :members: + :undoc-members: + :show-inheritance: + +troposphere.elasticache module +------------------------------ + +.. automodule:: troposphere.elasticache + :members: + :undoc-members: + :show-inheritance: + +troposphere.elasticbeanstalk module +----------------------------------- + +.. automodule:: troposphere.elasticbeanstalk + :members: + :undoc-members: + :show-inheritance: + +troposphere.elasticloadbalancing module +--------------------------------------- + +.. automodule:: troposphere.elasticloadbalancing + :members: + :undoc-members: + :show-inheritance: + +troposphere.elasticloadbalancingv2 module +----------------------------------------- + +.. automodule:: troposphere.elasticloadbalancingv2 + :members: + :undoc-members: + :show-inheritance: + +troposphere.elasticsearch module +-------------------------------- + +.. automodule:: troposphere.elasticsearch + :members: + :undoc-members: + :show-inheritance: + +troposphere.emr module +---------------------- + +.. automodule:: troposphere.emr + :members: + :undoc-members: + :show-inheritance: + +troposphere.events module +------------------------- + +.. automodule:: troposphere.events + :members: + :undoc-members: + :show-inheritance: + +troposphere.firehose module +--------------------------- + +.. automodule:: troposphere.firehose + :members: + :undoc-members: + :show-inheritance: + +troposphere.iam module +---------------------- + +.. automodule:: troposphere.iam + :members: + :undoc-members: + :show-inheritance: + +troposphere.iot module +---------------------- + +.. automodule:: troposphere.iot + :members: + :undoc-members: + :show-inheritance: + +troposphere.kinesis module +-------------------------- + +.. automodule:: troposphere.kinesis + :members: + :undoc-members: + :show-inheritance: + +troposphere.kms module +---------------------- + +.. automodule:: troposphere.kms + :members: + :undoc-members: + :show-inheritance: + +troposphere.logs module +----------------------- + +.. automodule:: troposphere.logs + :members: + :undoc-members: + :show-inheritance: + +troposphere.opsworks module +--------------------------- + +.. automodule:: troposphere.opsworks + :members: + :undoc-members: + :show-inheritance: + +troposphere.policies module +--------------------------- + +.. automodule:: troposphere.policies + :members: + :undoc-members: + :show-inheritance: + +troposphere.rds module +---------------------- + +.. automodule:: troposphere.rds + :members: + :undoc-members: + :show-inheritance: + +troposphere.redshift module +--------------------------- + +.. automodule:: troposphere.redshift + :members: + :undoc-members: + :show-inheritance: + +troposphere.route53 module +-------------------------- + +.. automodule:: troposphere.route53 + :members: + :undoc-members: + :show-inheritance: + +troposphere.s3 module +--------------------- + +.. automodule:: troposphere.s3 + :members: + :undoc-members: + :show-inheritance: + +troposphere.sdb module +---------------------- + +.. automodule:: troposphere.sdb + :members: + :undoc-members: + :show-inheritance: + +troposphere.sns module +---------------------- + +.. automodule:: troposphere.sns + :members: + :undoc-members: + :show-inheritance: + +troposphere.sqs module +---------------------- + +.. automodule:: troposphere.sqs + :members: + :undoc-members: + :show-inheritance: + +troposphere.ssm module +---------------------- + +.. automodule:: troposphere.ssm + :members: + :undoc-members: + :show-inheritance: + +troposphere.template_generator module +------------------------------------- + +.. automodule:: troposphere.template_generator + :members: + :undoc-members: + :show-inheritance: + +troposphere.utils module +------------------------ + +.. automodule:: troposphere.utils + :members: + :undoc-members: + :show-inheritance: + +troposphere.validators module +----------------------------- + +.. automodule:: troposphere.validators + :members: + :undoc-members: + :show-inheritance: + +troposphere.waf module +---------------------- + +.. automodule:: troposphere.waf + :members: + :undoc-members: + :show-inheritance: + +troposphere.workspaces module +----------------------------- + +.. automodule:: troposphere.workspaces + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: troposphere + :members: + :undoc-members: + :show-inheritance: