aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjason2015-11-16 09:58:24 -0700
committerjason2015-11-16 09:58:24 -0700
commit186f036460e92c06cd49379e8458ad59031caf8f (patch)
tree0a22a46748864449b6d4bf164d5c3caea85d0665
parent935d86acb4c6a291fb4d0648503f4eca962e92b3 (diff)
downloadeventmq-186f036460e92c06cd49379e8458ad59031caf8f.tar.gz
eventmq-186f036460e92c06cd49379e8458ad59031caf8f.zip
add sphinx docs
-rw-r--r--docs/Makefile192
-rw-r--r--docs/conf.py292
-rw-r--r--docs/index.rst22
-rw-r--r--docs/make.bat263
4 files changed, 769 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..7c5b119
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,192 @@
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS =
6SPHINXBUILD = sphinx-build
7PAPER =
8BUILDDIR = _build
9
10# User-friendly check for sphinx-build
11ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13endif
14
15# Internal variables.
16PAPEROPT_a4 = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
22.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
23
24help:
25 @echo "Please use \`make <target>' where <target> is one of"
26 @echo " html to make standalone HTML files"
27 @echo " dirhtml to make HTML files named index.html in directories"
28 @echo " singlehtml to make a single large HTML file"
29 @echo " pickle to make pickle files"
30 @echo " json to make JSON files"
31 @echo " htmlhelp to make HTML files and a HTML help project"
32 @echo " qthelp to make HTML files and a qthelp project"
33 @echo " applehelp to make an Apple Help Book"
34 @echo " devhelp to make HTML files and a Devhelp project"
35 @echo " epub to make an epub"
36 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37 @echo " latexpdf to make LaTeX files and run them through pdflatex"
38 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39 @echo " text to make text files"
40 @echo " man to make manual pages"
41 @echo " texinfo to make Texinfo files"
42 @echo " info to make Texinfo files and run them through makeinfo"
43 @echo " gettext to make PO message catalogs"
44 @echo " changes to make an overview of all changed/added/deprecated items"
45 @echo " xml to make Docutils-native XML files"
46 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
47 @echo " linkcheck to check all external links for integrity"
48 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
49 @echo " coverage to run coverage check of the documentation (if enabled)"
50
51clean:
52 rm -rf $(BUILDDIR)/*
53
54html:
55 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56 @echo
57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
59dirhtml:
60 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61 @echo
62 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
64singlehtml:
65 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66 @echo
67 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
69pickle:
70 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71 @echo
72 @echo "Build finished; now you can process the pickle files."
73
74json:
75 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76 @echo
77 @echo "Build finished; now you can process the JSON files."
78
79htmlhelp:
80 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81 @echo
82 @echo "Build finished; now you can run HTML Help Workshop with the" \
83 ".hhp project file in $(BUILDDIR)/htmlhelp."
84
85qthelp:
86 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87 @echo
88 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
89 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EventMQ.qhcp"
91 @echo "To view the help file:"
92 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EventMQ.qhc"
93
94applehelp:
95 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
96 @echo
97 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
98 @echo "N.B. You won't be able to view it unless you put it in" \
99 "~/Library/Documentation/Help or install it in your application" \
100 "bundle."
101
102devhelp:
103 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
104 @echo
105 @echo "Build finished."
106 @echo "To view the help file:"
107 @echo "# mkdir -p $$HOME/.local/share/devhelp/EventMQ"
108 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EventMQ"
109 @echo "# devhelp"
110
111epub:
112 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113 @echo
114 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115
116latex:
117 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118 @echo
119 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
120 @echo "Run \`make' in that directory to run these through (pdf)latex" \
121 "(use \`make latexpdf' here to do that automatically)."
122
123latexpdf:
124 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125 @echo "Running LaTeX files through pdflatex..."
126 $(MAKE) -C $(BUILDDIR)/latex all-pdf
127 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128
129latexpdfja:
130 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
131 @echo "Running LaTeX files through platex and dvipdfmx..."
132 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
133 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
134
135text:
136 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137 @echo
138 @echo "Build finished. The text files are in $(BUILDDIR)/text."
139
140man:
141 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142 @echo
143 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144
145texinfo:
146 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
147 @echo
148 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
149 @echo "Run \`make' in that directory to run these through makeinfo" \
150 "(use \`make info' here to do that automatically)."
151
152info:
153 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154 @echo "Running Texinfo files through makeinfo..."
155 make -C $(BUILDDIR)/texinfo info
156 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
157
158gettext:
159 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160 @echo
161 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162
163changes:
164 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165 @echo
166 @echo "The overview file is in $(BUILDDIR)/changes."
167
168linkcheck:
169 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
170 @echo
171 @echo "Link check complete; look for any errors in the above output " \
172 "or in $(BUILDDIR)/linkcheck/output.txt."
173
174doctest:
175 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
176 @echo "Testing of doctests in the sources finished, look at the " \
177 "results in $(BUILDDIR)/doctest/output.txt."
178
179coverage:
180 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
181 @echo "Testing of coverage in the sources finished, look at the " \
182 "results in $(BUILDDIR)/coverage/python.txt."
183
184xml:
185 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186 @echo
187 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188
189pseudoxml:
190 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191 @echo
192 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..ba94e45
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,292 @@
1# -*- coding: utf-8 -*-
2#
3# EventMQ documentation build configuration file, created by
4# sphinx-quickstart on Sun Nov 15 16:46:15 2015.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15import sys
16import os
17import shlex
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration ------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
32extensions = [
33 'sphinx.ext.autodoc',
34 'sphinx.ext.intersphinx',
35 'sphinx.ext.coverage',
36]
37
38# Add any paths that contain templates here, relative to this directory.
39templates_path = ['_templates']
40
41# The suffix(es) of source filenames.
42# You can specify multiple suffix as a list of string:
43# source_suffix = ['.rst', '.md']
44source_suffix = '.rst'
45
46# The encoding of source files.
47#source_encoding = 'utf-8-sig'
48
49# The master toctree document.
50master_doc = 'index'
51
52# General information about the project.
53project = u'EventMQ'
54copyright = u'2015, eventboard.io'
55author = u'eventboard.io'
56
57# The version info for the project you're documenting, acts as replacement for
58# |version| and |release|, also used in various other places throughout the
59# built documents.
60#
61# The short X.Y version.
62version = '0'
63# The full version, including alpha/beta/rc tags.
64release = '0'
65
66# The language for content autogenerated by Sphinx. Refer to documentation
67# for a list of supported languages.
68#
69# This is also used if you do content translation via gettext catalogs.
70# Usually you set "language" from the command line for these cases.
71language = None
72
73# There are two options for replacing |today|: either, you set today to some
74# non-false value, then it is used:
75#today = ''
76# Else, today_fmt is used as the format for a strftime call.
77#today_fmt = '%B %d, %Y'
78
79# List of patterns, relative to source directory, that match files and
80# directories to ignore when looking for source files.
81exclude_patterns = ['_build']
82
83# The reST default role (used for this markup: `text`) to use for all
84# documents.
85#default_role = None
86
87# If true, '()' will be appended to :func: etc. cross-reference text.
88#add_function_parentheses = True
89
90# If true, the current module name will be prepended to all description
91# unit titles (such as .. function::).
92#add_module_names = True
93
94# If true, sectionauthor and moduleauthor directives will be shown in the
95# output. They are ignored by default.
96#show_authors = False
97
98# The name of the Pygments (syntax highlighting) style to use.
99pygments_style = 'sphinx'
100
101# A list of ignored prefixes for module index sorting.
102#modindex_common_prefix = []
103
104# If true, keep warnings as "system message" paragraphs in the built documents.
105#keep_warnings = False
106
107# If true, `todo` and `todoList` produce output, else they produce nothing.
108todo_include_todos = False
109
110
111# -- Options for HTML output ----------------------------------------------
112
113# The theme to use for HTML and HTML Help pages. See the documentation for
114# a list of builtin themes.
115html_theme = 'alabaster'
116
117# Theme options are theme-specific and customize the look and feel of a theme
118# further. For a list of options available for each theme, see the
119# documentation.
120#html_theme_options = {}
121
122# Add any paths that contain custom themes here, relative to this directory.
123#html_theme_path = []
124
125# The name for this set of Sphinx documents. If None, it defaults to
126# "<project> v<release> documentation".
127#html_title = None
128
129# A shorter title for the navigation bar. Default is the same as html_title.
130#html_short_title = None
131
132# The name of an image file (relative to this directory) to place at the top
133# of the sidebar.
134#html_logo = None
135
136# The name of an image file (within the static path) to use as favicon of the
137# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138# pixels large.
139#html_favicon = None
140
141# Add any paths that contain custom static files (such as style sheets) here,
142# relative to this directory. They are copied after the builtin static files,
143# so a file named "default.css" will overwrite the builtin "default.css".
144html_static_path = ['_static']
145
146# Add any extra paths that contain custom files (such as robots.txt or
147# .htaccess) here, relative to this directory. These files are copied
148# directly to the root of the documentation.
149#html_extra_path = []
150
151# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152# using the given strftime format.
153#html_last_updated_fmt = '%b %d, %Y'
154
155# If true, SmartyPants will be used to convert quotes and dashes to
156# typographically correct entities.
157#html_use_smartypants = True
158
159# Custom sidebar templates, maps document names to template names.
160#html_sidebars = {}
161
162# Additional templates that should be rendered to pages, maps page names to
163# template names.
164#html_additional_pages = {}
165
166# If false, no module index is generated.
167#html_domain_indices = True
168
169# If false, no index is generated.
170#html_use_index = True
171
172# If true, the index is split into individual pages for each letter.
173#html_split_index = False
174
175# If true, links to the reST sources are added to the pages.
176#html_show_sourcelink = True
177
178# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
179#html_show_sphinx = True
180
181# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
182#html_show_copyright = True
183
184# If true, an OpenSearch description file will be output, and all pages will
185# contain a <link> tag referring to it. The value of this option must be the
186# base URL from which the finished HTML is served.
187#html_use_opensearch = ''
188
189# This is the file name suffix for HTML files (e.g. ".xhtml").
190#html_file_suffix = None
191
192# Language to be used for generating the HTML full-text search index.
193# Sphinx supports the following languages:
194# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
195# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
196#html_search_language = 'en'
197
198# A dictionary with options for the search language support, empty by default.
199# Now only 'ja' uses this config value
200#html_search_options = {'type': 'default'}
201
202# The name of a javascript file (relative to the configuration directory) that
203# implements a search results scorer. If empty, the default will be used.
204#html_search_scorer = 'scorer.js'
205
206# Output file base name for HTML help builder.
207htmlhelp_basename = 'EventMQdoc'
208
209# -- Options for LaTeX output ---------------------------------------------
210
211latex_elements = {
212# The paper size ('letterpaper' or 'a4paper').
213#'papersize': 'letterpaper',
214
215# The font size ('10pt', '11pt' or '12pt').
216#'pointsize': '10pt',
217
218# Additional stuff for the LaTeX preamble.
219#'preamble': '',
220
221# Latex figure (float) alignment
222#'figure_align': 'htbp',
223}
224
225# Grouping the document tree into LaTeX files. List of tuples
226# (source start file, target name, title,
227# author, documentclass [howto, manual, or own class]).
228latex_documents = [
229 (master_doc, 'EventMQ.tex', u'EventMQ Documentation',
230 u'eventboard.io', 'manual'),
231]
232
233# The name of an image file (relative to this directory) to place at the top of
234# the title page.
235#latex_logo = None
236
237# For "manual" documents, if this is true, then toplevel headings are parts,
238# not chapters.
239#latex_use_parts = False
240
241# If true, show page references after internal links.
242#latex_show_pagerefs = False
243
244# If true, show URL addresses after external links.
245#latex_show_urls = False
246
247# Documents to append as an appendix to all manuals.
248#latex_appendices = []
249
250# If false, no module index is generated.
251#latex_domain_indices = True
252
253
254# -- Options for manual page output ---------------------------------------
255
256# One entry per manual page. List of tuples
257# (source start file, name, description, authors, manual section).
258man_pages = [
259 (master_doc, 'eventmq', u'EventMQ Documentation',
260 [author], 1)
261]
262
263# If true, show URL addresses after external links.
264#man_show_urls = False
265
266
267# -- Options for Texinfo output -------------------------------------------
268
269# Grouping the document tree into Texinfo files. List of tuples
270# (source start file, target name, title, author,
271# dir menu entry, description, category)
272texinfo_documents = [
273 (master_doc, 'EventMQ', u'EventMQ Documentation',
274 author, 'EventMQ', 'One line description of project.',
275 'Miscellaneous'),
276]
277
278# Documents to append as an appendix to all manuals.
279#texinfo_appendices = []
280
281# If false, no module index is generated.
282#texinfo_domain_indices = True
283
284# How to display URL addresses: 'footnote', 'no', or 'inline'.
285#texinfo_show_urls = 'footnote'
286
287# If true, do not generate a @detailmenu in the "Top" node's menu.
288#texinfo_no_detailmenu = False
289
290
291# Example configuration for intersphinx: refer to the Python standard library.
292intersphinx_mapping = {'https://docs.python.org/': None}
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..842e8bb
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
1.. EventMQ documentation master file, created by
2 sphinx-quickstart on Sun Nov 15 16:46:15 2015.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6Welcome to EventMQ's documentation!
7===================================
8
9Contents:
10
11.. toctree::
12 :maxdepth: 2
13
14
15
16Indices and tables
17==================
18
19* :ref:`genindex`
20* :ref:`modindex`
21* :ref:`search`
22
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..24c8d51
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,263 @@
1@ECHO OFF
2
3REM Command file for Sphinx documentation
4
5if "%SPHINXBUILD%" == "" (
6 set SPHINXBUILD=sphinx-build
7)
8set BUILDDIR=_build
9set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10set I18NSPHINXOPTS=%SPHINXOPTS% .
11if NOT "%PAPER%" == "" (
12 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14)
15
16if "%1" == "" goto help
17
18if "%1" == "help" (
19 :help
20 echo.Please use `make ^<target^>` where ^<target^> is one of
21 echo. html to make standalone HTML files
22 echo. dirhtml to make HTML files named index.html in directories
23 echo. singlehtml to make a single large HTML file
24 echo. pickle to make pickle files
25 echo. json to make JSON files
26 echo. htmlhelp to make HTML files and a HTML help project
27 echo. qthelp to make HTML files and a qthelp project
28 echo. devhelp to make HTML files and a Devhelp project
29 echo. epub to make an epub
30 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31 echo. text to make text files
32 echo. man to make manual pages
33 echo. texinfo to make Texinfo files
34 echo. gettext to make PO message catalogs
35 echo. changes to make an overview over all changed/added/deprecated items
36 echo. xml to make Docutils-native XML files
37 echo. pseudoxml to make pseudoxml-XML files for display purposes
38 echo. linkcheck to check all external links for integrity
39 echo. doctest to run all doctests embedded in the documentation if enabled
40 echo. coverage to run coverage check of the documentation if enabled
41 goto end
42)
43
44if "%1" == "clean" (
45 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
46 del /q /s %BUILDDIR%\*
47 goto end
48)
49
50
51REM Check if sphinx-build is available and fallback to Python version if any
52%SPHINXBUILD% 2> nul
53if errorlevel 9009 goto sphinx_python
54goto sphinx_ok
55
56:sphinx_python
57
58set SPHINXBUILD=python -m sphinx.__init__
59%SPHINXBUILD% 2> nul
60if errorlevel 9009 (
61 echo.
62 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
63 echo.installed, then set the SPHINXBUILD environment variable to point
64 echo.to the full path of the 'sphinx-build' executable. Alternatively you
65 echo.may add the Sphinx directory to PATH.
66 echo.
67 echo.If you don't have Sphinx installed, grab it from
68 echo.http://sphinx-doc.org/
69 exit /b 1
70)
71
72:sphinx_ok
73
74
75if "%1" == "html" (
76 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
77 if errorlevel 1 exit /b 1
78 echo.
79 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
80 goto end
81)
82
83if "%1" == "dirhtml" (
84 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
85 if errorlevel 1 exit /b 1
86 echo.
87 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
88 goto end
89)
90
91if "%1" == "singlehtml" (
92 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
93 if errorlevel 1 exit /b 1
94 echo.
95 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
96 goto end
97)
98
99if "%1" == "pickle" (
100 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
101 if errorlevel 1 exit /b 1
102 echo.
103 echo.Build finished; now you can process the pickle files.
104 goto end
105)
106
107if "%1" == "json" (
108 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
109 if errorlevel 1 exit /b 1
110 echo.
111 echo.Build finished; now you can process the JSON files.
112 goto end
113)
114
115if "%1" == "htmlhelp" (
116 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
117 if errorlevel 1 exit /b 1
118 echo.
119 echo.Build finished; now you can run HTML Help Workshop with the ^
120.hhp project file in %BUILDDIR%/htmlhelp.
121 goto end
122)
123
124if "%1" == "qthelp" (
125 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
126 if errorlevel 1 exit /b 1
127 echo.
128 echo.Build finished; now you can run "qcollectiongenerator" with the ^
129.qhcp project file in %BUILDDIR%/qthelp, like this:
130 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\EventMQ.qhcp
131 echo.To view the help file:
132 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\EventMQ.ghc
133 goto end
134)
135
136if "%1" == "devhelp" (
137 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
138 if errorlevel 1 exit /b 1
139 echo.
140 echo.Build finished.
141 goto end
142)
143
144if "%1" == "epub" (
145 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
146 if errorlevel 1 exit /b 1
147 echo.
148 echo.Build finished. The epub file is in %BUILDDIR%/epub.
149 goto end
150)
151
152if "%1" == "latex" (
153 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
154 if errorlevel 1 exit /b 1
155 echo.
156 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
157 goto end
158)
159
160if "%1" == "latexpdf" (
161 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
162 cd %BUILDDIR%/latex
163 make all-pdf
164 cd %~dp0
165 echo.
166 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
167 goto end
168)
169
170if "%1" == "latexpdfja" (
171 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
172 cd %BUILDDIR%/latex
173 make all-pdf-ja
174 cd %~dp0
175 echo.
176 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
177 goto end
178)
179
180if "%1" == "text" (
181 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
182 if errorlevel 1 exit /b 1
183 echo.
184 echo.Build finished. The text files are in %BUILDDIR%/text.
185 goto end
186)
187
188if "%1" == "man" (
189 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
190 if errorlevel 1 exit /b 1
191 echo.
192 echo.Build finished. The manual pages are in %BUILDDIR%/man.
193 goto end
194)
195
196if "%1" == "texinfo" (
197 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
198 if errorlevel 1 exit /b 1
199 echo.
200 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
201 goto end
202)
203
204if "%1" == "gettext" (
205 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
206 if errorlevel 1 exit /b 1
207 echo.
208 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
209 goto end
210)
211
212if "%1" == "changes" (
213 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
214 if errorlevel 1 exit /b 1
215 echo.
216 echo.The overview file is in %BUILDDIR%/changes.
217 goto end
218)
219
220if "%1" == "linkcheck" (
221 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
222 if errorlevel 1 exit /b 1
223 echo.
224 echo.Link check complete; look for any errors in the above output ^
225or in %BUILDDIR%/linkcheck/output.txt.
226 goto end
227)
228
229if "%1" == "doctest" (
230 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
231 if errorlevel 1 exit /b 1
232 echo.
233 echo.Testing of doctests in the sources finished, look at the ^
234results in %BUILDDIR%/doctest/output.txt.
235 goto end
236)
237
238if "%1" == "coverage" (
239 %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
240 if errorlevel 1 exit /b 1
241 echo.
242 echo.Testing of coverage in the sources finished, look at the ^
243results in %BUILDDIR%/coverage/python.txt.
244 goto end
245)
246
247if "%1" == "xml" (
248 %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
249 if errorlevel 1 exit /b 1
250 echo.
251 echo.Build finished. The XML files are in %BUILDDIR%/xml.
252 goto end
253)
254
255if "%1" == "pseudoxml" (
256 %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
257 if errorlevel 1 exit /b 1
258 echo.
259 echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
260 goto end
261)
262
263:end