[llvm-commits] [zorg] r141394 - in /zorg/trunk/llvmlab/docs: ./ Makefile README.txt _templates/ _templates/index.html _templates/indexsidebar.html _templates/layout.html conf.py contents.rst intro.rst make.bat
Daniel Dunbar
daniel at zuster.org
Fri Oct 7 12:54:46 PDT 2011
Author: ddunbar
Date: Fri Oct 7 14:54:46 2011
New Revision: 141394
URL: http://llvm.org/viewvc/llvm-project?rev=141394&view=rev
Log:
llvmlab: Stub out some simple Sphinx documentation structure.
Added:
zorg/trunk/llvmlab/docs/
zorg/trunk/llvmlab/docs/Makefile
zorg/trunk/llvmlab/docs/README.txt
zorg/trunk/llvmlab/docs/_templates/
zorg/trunk/llvmlab/docs/_templates/index.html
zorg/trunk/llvmlab/docs/_templates/indexsidebar.html
zorg/trunk/llvmlab/docs/_templates/layout.html
zorg/trunk/llvmlab/docs/conf.py
zorg/trunk/llvmlab/docs/contents.rst
zorg/trunk/llvmlab/docs/intro.rst
zorg/trunk/llvmlab/docs/make.bat
Added: zorg/trunk/llvmlab/docs/Makefile
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/Makefile?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/Makefile (added)
+++ zorg/trunk/llvmlab/docs/Makefile Fri Oct 7 14:54:46 2011
@@ -0,0 +1,120 @@
+# 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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest
+
+all: html
+
+help:
+ @echo "Please use \`make <target>' where <target> 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 " changes to make an overview of all changed/added/deprecated items"
+ @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)/*
+
+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/LNT.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LNT.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/LNT"
+ @echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/LNT"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+latexpdf: latex
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C _build/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in _build/latex."
+
+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."
Added: zorg/trunk/llvmlab/docs/README.txt
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/README.txt?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/README.txt (added)
+++ zorg/trunk/llvmlab/docs/README.txt Fri Oct 7 14:54:46 2011
@@ -0,0 +1,7 @@
+llvmlab Documentation
+=====================
+
+The llvmlab documentation is written using the Sphinx documentation generator. It is
+currently tested with Sphinx 1.0dev.
+
+We currently use the 'nature' theme and a Beaker inspired structure.
Added: zorg/trunk/llvmlab/docs/_templates/index.html
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/_templates/index.html?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/_templates/index.html (added)
+++ zorg/trunk/llvmlab/docs/_templates/index.html Fri Oct 7 14:54:46 2011
@@ -0,0 +1,37 @@
+{% extends "layout.html" %}
+{% set title = 'llvmlab' %}
+{% block body %}
+<h1>llvmlab - LLVM Dashboard</h1>
+
+<p>
+ <i>llvmlab</i> is a dashboard for the LLVM project.
+
+ This is the web page for the <i>llvmlab</i> software itself, the current online
+ version of the server is available
+ at <a href="http://lab.llvm.org/lab/">http://lab.llvm.org/lab/</a>.
+</p>
+
+<h2>Documentation</h2>
+<table class="contentstable" align="center" style="margin-left: 30px">
+ <tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">
+ Contents</a><br/>
+ <span class="linkdescr">for a complete overview</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">
+ Search page</a><br/>
+ <span class="linkdescr">search the documentation</span></p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">
+ General Index</a><br/>
+ <span class="linkdescr">all functions, classes, terms</span></p>
+ </td></tr>
+</table>
+
+<h2>Source</h2>
+<p><i>llvmlab</i> is available in the LLVM "zorg" SVN repository:
+ <tt>svn co
+ <a href="http://llvm.org/svn/llvm-project/zorg/trunk/llvmlab">
+ http://llvm.org/svn/llvm-project/zorg/trunk/llvmlab</a></tt>.</p>
+
+{% endblock %}
Added: zorg/trunk/llvmlab/docs/_templates/indexsidebar.html
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/_templates/indexsidebar.html?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/_templates/indexsidebar.html (added)
+++ zorg/trunk/llvmlab/docs/_templates/indexsidebar.html Fri Oct 7 14:54:46 2011
@@ -0,0 +1,4 @@
+<h3>Bugs</h3>
+
+<p>llvmlab bugs should be reported at the
+ LLVM <a href="http://llvm.org/bugs">Bugzilla</a>.</p>
Added: zorg/trunk/llvmlab/docs/_templates/layout.html
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/_templates/layout.html?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/_templates/layout.html (added)
+++ zorg/trunk/llvmlab/docs/_templates/layout.html Fri Oct 7 14:54:46 2011
@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+
+{% block extrahead %}
+<style type="text/css">
+ table.right { float: right; margin-left: 20px; }
+ table.right td { border: 1px solid #ccc; }
+</style>
+{% endblock %}
+
+{% block rootrellink %}
+ <li><a href="{{ pathto('index') }}">Home</a> | </li>
+ <li><a href="{{ pathto('contents') }}">Documentation</a>»</li>
+{% endblock %}
Added: zorg/trunk/llvmlab/docs/conf.py
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/conf.py?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/conf.py (added)
+++ zorg/trunk/llvmlab/docs/conf.py Fri Oct 7 14:54:46 2011
@@ -0,0 +1,241 @@
+# -*- coding: utf-8 -*-
+#
+# Documentation build configuration file.
+#
+# 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.
+
+import datetime, sys, os
+
+# 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.
+sys.path.append(os.path.abspath('..'))
+
+import llvmlab
+
+project = "llvmlab"
+project_module = llvmlab
+
+# -- 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', 'sphinx.ext.doctest', 'sphinx.ext.coverage']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+copyright = u'%s, %s' % (datetime.datetime.now().year,
+ project_module.__author__)
+
+# 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 = project_module.__version__
+# The full version, including alpha/beta/rc tags.
+release = project_module.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#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 = '%Y-%m-%d'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = True
+
+# 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 = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%Y-%m-%d'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {'index': 'indexsidebar.html'}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+html_additional_pages = {'index': 'index.html'}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('contents', '%s.tex' % project, u'%s Documentation' % project,
+ project_module.__author__, 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+#epub_title = ''
+#epub_author = ''
+#epub_publisher = ''
+#epub_copyright = ''
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
Added: zorg/trunk/llvmlab/docs/contents.rst
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/contents.rst?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/contents.rst (added)
+++ zorg/trunk/llvmlab/docs/contents.rst Fri Oct 7 14:54:46 2011
@@ -0,0 +1,15 @@
+.. _contents:
+
+Contents
+========
+
+.. toctree::
+ :maxdepth: 2
+
+ intro
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
Added: zorg/trunk/llvmlab/docs/intro.rst
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/intro.rst?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/intro.rst (added)
+++ zorg/trunk/llvmlab/docs/intro.rst Fri Oct 7 14:54:46 2011
@@ -0,0 +1,70 @@
+.. _intro:
+
+Introduction
+============
+
+Installation
+------------
+
+These are the (current) rough steps to get a working llvmlab server:
+
+ 1. Install llvmlab::
+
+ python setup.py install
+
+ It is recommended that you install llvmlab into a virtualenv. If you are
+ developing the software, you presumably want to use::
+
+ python setup.py develop
+
+ 2. Create a new llvmlab installation::
+
+ llvmlab create \
+ --master-url http://example.com:8010 \
+ --plugin-module zorg.llvmlab
+ path/to/install-dir
+
+ This will create the llvmlab configuration file, the default database, and a
+ .wsgi wrapper to create the application. If using this instance for
+ development, you may want to add the ``--debug-server`` argument to default
+ to running the server in debug mode.
+
+ The ``--master-url`` should be used to point the lab at the buildbot
+ installation it is intended to monitor. You can monitor ``lab.llvm.org`` for
+ quick testing purposes, but **please** do not leave this running for an
+ extended time, as it puts a certain amount of load on the buildbot
+ installation. If you want to run longer tests, please run a local buildbot
+ master and monitor that.
+
+ The ``--plugin-module`` argument is required in order for the dashboard to
+ work, it is how the dashboard loads the information about the buildbot
+ configuration. The module path is expected to be importable, so you may need
+ to extend the PYTHONPATH to support that (e.g.,
+ ``PYTHONPATH=/path/to/zorg/repo`` would allow the default ``lab.llvm.org``
+ plugin named above to be imported).
+
+ If using this instance for deployment, you *certainly* want to provide the
+ ``--admin-email`` and ``--admin-password`` arguments to override the
+ defaults. You may also need to modify the generated ``app.cfg`` file to
+ change the default SMTP relay server (used for mailing error messages).
+
+ You can execute the generated WSGI app directly to run with the builtin web
+ server, or use::
+
+ env LLVMLAB_CONFIG=/path/to/instance/lab.cfg llvmlab runserver
+
+ which may eventually provide additional command line options. Neither of
+ these servers is recommended for production use.
+
+ 3. Add the 'app.wsgi' app to your Apache configuration. You should set also
+ configure the WSGIDaemonProcess and WSGIProcessGroup variables if not
+ already done.
+
+ If running in a virtualenv you will need to configure that as well; see the
+ `modwsgi wiki <http://code.google.com/p/modwsgi/wiki/VirtualEnvironments>`_.
+
+
+Architecture
+------------
+
+The llvmlab web app is currently implemented as a WSGI web app using Flask.
Added: zorg/trunk/llvmlab/docs/make.bat
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/llvmlab/docs/make.bat?rev=141394&view=auto
==============================================================================
--- zorg/trunk/llvmlab/docs/make.bat (added)
+++ zorg/trunk/llvmlab/docs/make.bat Fri Oct 7 14:54:46 2011
@@ -0,0 +1,113 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ 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. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "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.
+ goto end
+)
+
+if "%1" == "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\LNT.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\LNT.ghc
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "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.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
More information about the llvm-commits
mailing list