Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Start with documentation

  • Loading branch information...
commit ee75cfee7b291dcd49f3406b884c293c62994e12 1 parent 4bd4073
Benjamin Eberlei beberlei authored
1  .gitignore
... ... @@ -1,2 +1,3 @@
1 1 vendor
2 2 *phpunit.xml
  3 +docs/_build
3  .gitmodules
... ... @@ -0,0 +1,3 @@
  1 +[submodule "docs/_theme"]
  2 + path = docs/_theme
  3 + url = git://github.com/doctrine/doctrine-sphinx-theme.git
153 docs/Makefile
... ... @@ -0,0 +1,153 @@
  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 +# Internal variables.
  11 +PAPEROPT_a4 = -D latex_paper_size=a4
  12 +PAPEROPT_letter = -D latex_paper_size=letter
  13 +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  14 +# the i18n builder cannot share the environment and doctrees with the others
  15 +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  16 +
  17 +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  18 +
  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 " latexpdf to make LaTeX files and run them through pdflatex"
  32 + @echo " text to make text files"
  33 + @echo " man to make manual pages"
  34 + @echo " texinfo to make Texinfo files"
  35 + @echo " info to make Texinfo files and run them through makeinfo"
  36 + @echo " gettext to make PO message catalogs"
  37 + @echo " changes to make an overview of all changed/added/deprecated items"
  38 + @echo " linkcheck to check all external links for integrity"
  39 + @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  40 +
  41 +clean:
  42 + -rm -rf $(BUILDDIR)/*
  43 +
  44 +html:
  45 + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  46 + @echo
  47 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  48 +
  49 +dirhtml:
  50 + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  51 + @echo
  52 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  53 +
  54 +singlehtml:
  55 + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  56 + @echo
  57 + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  58 +
  59 +pickle:
  60 + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  61 + @echo
  62 + @echo "Build finished; now you can process the pickle files."
  63 +
  64 +json:
  65 + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  66 + @echo
  67 + @echo "Build finished; now you can process the JSON files."
  68 +
  69 +htmlhelp:
  70 + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  71 + @echo
  72 + @echo "Build finished; now you can run HTML Help Workshop with the" \
  73 + ".hhp project file in $(BUILDDIR)/htmlhelp."
  74 +
  75 +qthelp:
  76 + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  77 + @echo
  78 + @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  79 + ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  80 + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DoctrineKeyValueStore.qhcp"
  81 + @echo "To view the help file:"
  82 + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DoctrineKeyValueStore.qhc"
  83 +
  84 +devhelp:
  85 + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  86 + @echo
  87 + @echo "Build finished."
  88 + @echo "To view the help file:"
  89 + @echo "# mkdir -p $$HOME/.local/share/devhelp/DoctrineKeyValueStore"
  90 + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DoctrineKeyValueStore"
  91 + @echo "# devhelp"
  92 +
  93 +epub:
  94 + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  95 + @echo
  96 + @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  97 +
  98 +latex:
  99 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  100 + @echo
  101 + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  102 + @echo "Run \`make' in that directory to run these through (pdf)latex" \
  103 + "(use \`make latexpdf' here to do that automatically)."
  104 +
  105 +latexpdf:
  106 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  107 + @echo "Running LaTeX files through pdflatex..."
  108 + $(MAKE) -C $(BUILDDIR)/latex all-pdf
  109 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  110 +
  111 +text:
  112 + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  113 + @echo
  114 + @echo "Build finished. The text files are in $(BUILDDIR)/text."
  115 +
  116 +man:
  117 + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  118 + @echo
  119 + @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  120 +
  121 +texinfo:
  122 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  123 + @echo
  124 + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  125 + @echo "Run \`make' in that directory to run these through makeinfo" \
  126 + "(use \`make info' here to do that automatically)."
  127 +
  128 +info:
  129 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  130 + @echo "Running Texinfo files through makeinfo..."
  131 + make -C $(BUILDDIR)/texinfo info
  132 + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  133 +
  134 +gettext:
  135 + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  136 + @echo
  137 + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  138 +
  139 +changes:
  140 + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  141 + @echo
  142 + @echo "The overview file is in $(BUILDDIR)/changes."
  143 +
  144 +linkcheck:
  145 + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  146 + @echo
  147 + @echo "Link check complete; look for any errors in the above output " \
  148 + "or in $(BUILDDIR)/linkcheck/output.txt."
  149 +
  150 +doctest:
  151 + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  152 + @echo "Testing of doctests in the sources finished, look at the " \
  153 + "results in $(BUILDDIR)/doctest/output.txt."
1  docs/_theme
... ... @@ -0,0 +1 @@
  1 +Subproject commit 5aa024c9284228ed76c7a9aa785229cf19f396e3
242 docs/conf.py
... ... @@ -0,0 +1,242 @@
  1 +# -*- coding: utf-8 -*-
  2 +#
  3 +# Doctrine KeyValueStore documentation build configuration file, created by
  4 +# sphinx-quickstart on Sun Jan 27 16:47:49 2013.
  5 +#
  6 +# This file is execfile()d with the current directory set to its containing dir.
  7 +#
  8 +# Note that not all possible configuration values are present in this
  9 +# autogenerated file.
  10 +#
  11 +# All configuration values have a default; values that are commented out
  12 +# serve to show the default.
  13 +
  14 +import sys, os
  15 +
  16 +# If extensions (or modules to document with autodoc) are in another directory,
  17 +# add these directories to sys.path here. If the directory is relative to the
  18 +# documentation root, use os.path.abspath to make it absolute, like shown here.
  19 +#sys.path.insert(0, os.path.abspath('.'))
  20 +
  21 +# -- General configuration -----------------------------------------------------
  22 +
  23 +# If your documentation needs a minimal Sphinx version, state it here.
  24 +#needs_sphinx = '1.0'
  25 +
  26 +# Add any Sphinx extension module names here, as strings. They can be extensions
  27 +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  28 +extensions = []
  29 +
  30 +# Add any paths that contain templates here, relative to this directory.
  31 +templates_path = ['_templates']
  32 +
  33 +# The suffix of source filenames.
  34 +source_suffix = '.rst'
  35 +
  36 +# The encoding of source files.
  37 +#source_encoding = 'utf-8-sig'
  38 +
  39 +# The master toctree document.
  40 +master_doc = 'index'
  41 +
  42 +# General information about the project.
  43 +project = u'Doctrine KeyValueStore'
  44 +copyright = u'2013, Doctrine Team'
  45 +
  46 +# The version info for the project you're documenting, acts as replacement for
  47 +# |version| and |release|, also used in various other places throughout the
  48 +# built documents.
  49 +#
  50 +# The short X.Y version.
  51 +version = '1.0'
  52 +# The full version, including alpha/beta/rc tags.
  53 +release = '1.0'
  54 +
  55 +# The language for content autogenerated by Sphinx. Refer to documentation
  56 +# for a list of supported languages.
  57 +#language = None
  58 +
  59 +# There are two options for replacing |today|: either, you set today to some
  60 +# non-false value, then it is used:
  61 +#today = ''
  62 +# Else, today_fmt is used as the format for a strftime call.
  63 +#today_fmt = '%B %d, %Y'
  64 +
  65 +# List of patterns, relative to source directory, that match files and
  66 +# directories to ignore when looking for source files.
  67 +exclude_patterns = ['_build']
  68 +
  69 +# The reST default role (used for this markup: `text`) to use for all documents.
  70 +#default_role = None
  71 +
  72 +# If true, '()' will be appended to :func: etc. cross-reference text.
  73 +#add_function_parentheses = True
  74 +
  75 +# If true, the current module name will be prepended to all description
  76 +# unit titles (such as .. function::).
  77 +#add_module_names = True
  78 +
  79 +# If true, sectionauthor and moduleauthor directives will be shown in the
  80 +# output. They are ignored by default.
  81 +#show_authors = False
  82 +
  83 +# The name of the Pygments (syntax highlighting) style to use.
  84 +pygments_style = 'sphinx'
  85 +
  86 +# A list of ignored prefixes for module index sorting.
  87 +#modindex_common_prefix = []
  88 +
  89 +
  90 +# -- Options for HTML output ---------------------------------------------------
  91 +
  92 +# The theme to use for HTML and HTML Help pages. See the documentation for
  93 +# a list of builtin themes.
  94 +html_theme = 'doctrine'
  95 +
  96 +# Theme options are theme-specific and customize the look and feel of a theme
  97 +# further. For a list of options available for each theme, see the
  98 +# documentation.
  99 +#html_theme_options = {}
  100 +
  101 +# Add any paths that contain custom themes here, relative to this directory.
  102 +html_theme_path = ['_theme']
  103 +
  104 +# The name for this set of Sphinx documents. If None, it defaults to
  105 +# "<project> v<release> documentation".
  106 +#html_title = None
  107 +
  108 +# A shorter title for the navigation bar. Default is the same as html_title.
  109 +#html_short_title = None
  110 +
  111 +# The name of an image file (relative to this directory) to place at the top
  112 +# of the sidebar.
  113 +#html_logo = None
  114 +
  115 +# The name of an image file (within the static path) to use as favicon of the
  116 +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  117 +# pixels large.
  118 +#html_favicon = None
  119 +
  120 +# Add any paths that contain custom static files (such as style sheets) here,
  121 +# relative to this directory. They are copied after the builtin static files,
  122 +# so a file named "default.css" will overwrite the builtin "default.css".
  123 +html_static_path = ['_static']
  124 +
  125 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  126 +# using the given strftime format.
  127 +#html_last_updated_fmt = '%b %d, %Y'
  128 +
  129 +# If true, SmartyPants will be used to convert quotes and dashes to
  130 +# typographically correct entities.
  131 +#html_use_smartypants = True
  132 +
  133 +# Custom sidebar templates, maps document names to template names.
  134 +#html_sidebars = {}
  135 +
  136 +# Additional templates that should be rendered to pages, maps page names to
  137 +# template names.
  138 +#html_additional_pages = {}
  139 +
  140 +# If false, no module index is generated.
  141 +#html_domain_indices = True
  142 +
  143 +# If false, no index is generated.
  144 +#html_use_index = True
  145 +
  146 +# If true, the index is split into individual pages for each letter.
  147 +#html_split_index = False
  148 +
  149 +# If true, links to the reST sources are added to the pages.
  150 +#html_show_sourcelink = True
  151 +
  152 +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  153 +#html_show_sphinx = True
  154 +
  155 +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  156 +#html_show_copyright = True
  157 +
  158 +# If true, an OpenSearch description file will be output, and all pages will
  159 +# contain a <link> tag referring to it. The value of this option must be the
  160 +# base URL from which the finished HTML is served.
  161 +#html_use_opensearch = ''
  162 +
  163 +# This is the file name suffix for HTML files (e.g. ".xhtml").
  164 +#html_file_suffix = None
  165 +
  166 +# Output file base name for HTML help builder.
  167 +htmlhelp_basename = 'DoctrineKeyValueStoredoc'
  168 +
  169 +
  170 +# -- Options for LaTeX output --------------------------------------------------
  171 +
  172 +latex_elements = {
  173 +# The paper size ('letterpaper' or 'a4paper').
  174 +#'papersize': 'letterpaper',
  175 +
  176 +# The font size ('10pt', '11pt' or '12pt').
  177 +#'pointsize': '10pt',
  178 +
  179 +# Additional stuff for the LaTeX preamble.
  180 +#'preamble': '',
  181 +}
  182 +
  183 +# Grouping the document tree into LaTeX files. List of tuples
  184 +# (source start file, target name, title, author, documentclass [howto/manual]).
  185 +latex_documents = [
  186 + ('index', 'DoctrineKeyValueStore.tex', u'Doctrine KeyValueStore Documentation',
  187 + u'Doctrine Team', 'manual'),
  188 +]
  189 +
  190 +# The name of an image file (relative to this directory) to place at the top of
  191 +# the title page.
  192 +#latex_logo = None
  193 +
  194 +# For "manual" documents, if this is true, then toplevel headings are parts,
  195 +# not chapters.
  196 +#latex_use_parts = False
  197 +
  198 +# If true, show page references after internal links.
  199 +#latex_show_pagerefs = False
  200 +
  201 +# If true, show URL addresses after external links.
  202 +#latex_show_urls = False
  203 +
  204 +# Documents to append as an appendix to all manuals.
  205 +#latex_appendices = []
  206 +
  207 +# If false, no module index is generated.
  208 +#latex_domain_indices = True
  209 +
  210 +
  211 +# -- Options for manual page output --------------------------------------------
  212 +
  213 +# One entry per manual page. List of tuples
  214 +# (source start file, name, description, authors, manual section).
  215 +man_pages = [
  216 + ('index', 'doctrinekeyvaluestore', u'Doctrine KeyValueStore Documentation',
  217 + [u'Doctrine Team'], 1)
  218 +]
  219 +
  220 +# If true, show URL addresses after external links.
  221 +#man_show_urls = False
  222 +
  223 +
  224 +# -- Options for Texinfo output ------------------------------------------------
  225 +
  226 +# Grouping the document tree into Texinfo files. List of tuples
  227 +# (source start file, target name, title, author,
  228 +# dir menu entry, description, category)
  229 +texinfo_documents = [
  230 + ('index', 'DoctrineKeyValueStore', u'Doctrine KeyValueStore Documentation',
  231 + u'Doctrine Team', 'DoctrineKeyValueStore', 'One line description of project.',
  232 + 'Miscellaneous'),
  233 +]
  234 +
  235 +# Documents to append as an appendix to all manuals.
  236 +#texinfo_appendices = []
  237 +
  238 +# If false, no module index is generated.
  239 +#texinfo_domain_indices = True
  240 +
  241 +# How to display URL addresses: 'footnote', 'no', or 'inline'.
  242 +#texinfo_show_urls = 'footnote'
22 docs/index.rst
Source Rendered
... ... @@ -0,0 +1,22 @@
  1 +.. Doctrine KeyValueStore documentation master file, created by
  2 + sphinx-quickstart on Sun Jan 27 16:47:49 2013.
  3 + You can adapt this file completely to your liking, but it should at least
  4 + contain the root `toctree` directive.
  5 +
  6 +Welcome to Doctrine KeyValueStore's documentation!
  7 +==================================================
  8 +
  9 +Contents:
  10 +
  11 +.. toctree::
  12 + :maxdepth: 2
  13 +
  14 +
  15 +
  16 +Indices and tables
  17 +==================
  18 +
  19 +* :ref:`genindex`
  20 +* :ref:`modindex`
  21 +* :ref:`search`
  22 +
190 docs/make.bat
... ... @@ -0,0 +1,190 @@
  1 +@ECHO OFF
  2 +
  3 +REM Command file for Sphinx documentation
  4 +
  5 +if "%SPHINXBUILD%" == "" (
  6 + set SPHINXBUILD=sphinx-build
  7 +)
  8 +set BUILDDIR=_build
  9 +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
  10 +set I18NSPHINXOPTS=%SPHINXOPTS% .
  11 +if NOT "%PAPER%" == "" (
  12 + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
  13 + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
  14 +)
  15 +
  16 +if "%1" == "" goto help
  17 +
  18 +if "%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. linkcheck to check all external links for integrity
  37 + echo. doctest to run all doctests embedded in the documentation if enabled
  38 + goto end
  39 +)
  40 +
  41 +if "%1" == "clean" (
  42 + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
  43 + del /q /s %BUILDDIR%\*
  44 + goto end
  45 +)
  46 +
  47 +if "%1" == "html" (
  48 + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
  49 + if errorlevel 1 exit /b 1
  50 + echo.
  51 + echo.Build finished. The HTML pages are in %BUILDDIR%/html.
  52 + goto end
  53 +)
  54 +
  55 +if "%1" == "dirhtml" (
  56 + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
  57 + if errorlevel 1 exit /b 1
  58 + echo.
  59 + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
  60 + goto end
  61 +)
  62 +
  63 +if "%1" == "singlehtml" (
  64 + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
  65 + if errorlevel 1 exit /b 1
  66 + echo.
  67 + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
  68 + goto end
  69 +)
  70 +
  71 +if "%1" == "pickle" (
  72 + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
  73 + if errorlevel 1 exit /b 1
  74 + echo.
  75 + echo.Build finished; now you can process the pickle files.
  76 + goto end
  77 +)
  78 +
  79 +if "%1" == "json" (
  80 + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
  81 + if errorlevel 1 exit /b 1
  82 + echo.
  83 + echo.Build finished; now you can process the JSON files.
  84 + goto end
  85 +)
  86 +
  87 +if "%1" == "htmlhelp" (
  88 + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
  89 + if errorlevel 1 exit /b 1
  90 + echo.
  91 + echo.Build finished; now you can run HTML Help Workshop with the ^
  92 +.hhp project file in %BUILDDIR%/htmlhelp.
  93 + goto end
  94 +)
  95 +
  96 +if "%1" == "qthelp" (
  97 + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
  98 + if errorlevel 1 exit /b 1
  99 + echo.
  100 + echo.Build finished; now you can run "qcollectiongenerator" with the ^
  101 +.qhcp project file in %BUILDDIR%/qthelp, like this:
  102 + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\DoctrineKeyValueStore.qhcp
  103 + echo.To view the help file:
  104 + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\DoctrineKeyValueStore.ghc
  105 + goto end
  106 +)
  107 +
  108 +if "%1" == "devhelp" (
  109 + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
  110 + if errorlevel 1 exit /b 1
  111 + echo.
  112 + echo.Build finished.
  113 + goto end
  114 +)
  115 +
  116 +if "%1" == "epub" (
  117 + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
  118 + if errorlevel 1 exit /b 1
  119 + echo.
  120 + echo.Build finished. The epub file is in %BUILDDIR%/epub.
  121 + goto end
  122 +)
  123 +
  124 +if "%1" == "latex" (
  125 + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
  126 + if errorlevel 1 exit /b 1
  127 + echo.
  128 + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
  129 + goto end
  130 +)
  131 +
  132 +if "%1" == "text" (
  133 + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
  134 + if errorlevel 1 exit /b 1
  135 + echo.
  136 + echo.Build finished. The text files are in %BUILDDIR%/text.
  137 + goto end
  138 +)
  139 +
  140 +if "%1" == "man" (
  141 + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
  142 + if errorlevel 1 exit /b 1
  143 + echo.
  144 + echo.Build finished. The manual pages are in %BUILDDIR%/man.
  145 + goto end
  146 +)
  147 +
  148 +if "%1" == "texinfo" (
  149 + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
  150 + if errorlevel 1 exit /b 1
  151 + echo.
  152 + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
  153 + goto end
  154 +)
  155 +
  156 +if "%1" == "gettext" (
  157 + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
  158 + if errorlevel 1 exit /b 1
  159 + echo.
  160 + echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
  161 + goto end
  162 +)
  163 +
  164 +if "%1" == "changes" (
  165 + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
  166 + if errorlevel 1 exit /b 1
  167 + echo.
  168 + echo.The overview file is in %BUILDDIR%/changes.
  169 + goto end
  170 +)
  171 +
  172 +if "%1" == "linkcheck" (
  173 + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
  174 + if errorlevel 1 exit /b 1
  175 + echo.
  176 + echo.Link check complete; look for any errors in the above output ^
  177 +or in %BUILDDIR%/linkcheck/output.txt.
  178 + goto end
  179 +)
  180 +
  181 +if "%1" == "doctest" (
  182 + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
  183 + if errorlevel 1 exit /b 1
  184 + echo.
  185 + echo.Testing of doctests in the sources finished, look at the ^
  186 +results in %BUILDDIR%/doctest/output.txt.
  187 + goto end
  188 +)
  189 +
  190 +:end

0 comments on commit ee75cfe

Please sign in to comment.
Something went wrong with that request. Please try again.