<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Available builders — Sphinx 1.1.3 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.1.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Sphinx 1.1.3 documentation"
href="_static/opensearch.xml"/>
<link rel="top" title="Sphinx 1.1.3 documentation" href="index.html" />
<link rel="next" title="The build configuration file" href="config.html" />
<link rel="prev" title="Sphinx Domains" href="domains.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<img src="_static/sphinx.png" alt="Sphinx logo" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="config.html" title="The build configuration file"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="domains.html" title="Sphinx Domains"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Sphinx home</a> | </li>
<li><a href="contents.html">Documentation</a>
»</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Available builders</a><ul>
<li><a class="reference internal" href="#serialization-builder-details">Serialization builder details</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="domains.html"
title="previous chapter">Sphinx Domains</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="config.html"
title="next chapter">The build configuration file</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/builders.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sphinx.builders">
<span id="available-builders"></span><span id="builders"></span><h1>Available builders<a class="headerlink" href="#module-sphinx.builders" title="Permalink to this headline">¶</a></h1>
<p>These are the built-in Sphinx builders. More builders can be added by
<a class="reference internal" href="extensions.html#extensions"><em>extensions</em></a>.</p>
<p>The builder’s “name” must be given to the <strong>-b</strong> command-line option of
<strong class="program">sphinx-build</strong> to select a builder.</p>
<span class="target" id="module-sphinx.builders.html"></span><dl class="class">
<dt id="sphinx.builders.html.StandaloneHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">StandaloneHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.StandaloneHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the standard HTML builder. Its output is a directory with HTML
files, complete with style sheets and optionally the reST sources. There are
quite a few configuration values that customize the output of this builder,
see the chapter <a class="reference internal" href="config.html#html-options"><em>Options for HTML output</em></a> for details.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">html</span></tt>.</p>
</dd></dl>
<dl class="class">
<dt id="sphinx.builders.html.DirectoryHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">DirectoryHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.DirectoryHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a subclass of the standard HTML builder. Its output is a directory
with HTML files, where each file is called <tt class="docutils literal"><span class="pre">index.html</span></tt> and placed in a
subdirectory named like its page name. For example, the document
<tt class="docutils literal"><span class="pre">markup/rest.rst</span></tt> will not result in an output file <tt class="docutils literal"><span class="pre">markup/rest.html</span></tt>,
but <tt class="docutils literal"><span class="pre">markup/rest/index.html</span></tt>. When generating links between pages, the
<tt class="docutils literal"><span class="pre">index.html</span></tt> is omitted, so that the URL would look like <tt class="docutils literal"><span class="pre">markup/rest/</span></tt>.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">dirhtml</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.6.</span></p>
</dd></dl>
<dl class="class">
<dt id="sphinx.builders.html.SingleFileHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">SingleFileHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.SingleFileHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This is an HTML builder that combines the whole project in one output file.
(Obviously this only works with smaller projects.) The file is named like
the master document. No indices will be generated.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">singlehtml</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.0.</span></p>
</dd></dl>
<span class="target" id="module-sphinx.builders.htmlhelp"></span><dl class="class">
<dt id="sphinx.builders.htmlhelp.HTMLHelpBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.htmlhelp.</tt><tt class="descname">HTMLHelpBuilder</tt><a class="headerlink" href="#sphinx.builders.htmlhelp.HTMLHelpBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces the same output as the standalone HTML builder, but
also generates HTML Help support files that allow the Microsoft HTML Help
Workshop to compile them into a CHM file.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">htmlhelp</span></tt>.</p>
</dd></dl>
<span class="target" id="module-sphinx.builders.qthelp"></span><dl class="class">
<dt id="sphinx.builders.qthelp.QtHelpBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.qthelp.</tt><tt class="descname">QtHelpBuilder</tt><a class="headerlink" href="#sphinx.builders.qthelp.QtHelpBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces the same output as the standalone HTML builder, but
also generates <a class="reference external" href="http://doc.trolltech.com/4.6/qthelp-framework.html">Qt help</a> collection support files that allow
the Qt collection generator to compile them.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">qthelp</span></tt>.</p>
</dd></dl>
<span class="target" id="module-sphinx.builders.devhelp"></span><dl class="class">
<dt id="sphinx.builders.devhelp.DevhelpBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.devhelp.</tt><tt class="descname">DevhelpBuilder</tt><a class="headerlink" href="#sphinx.builders.devhelp.DevhelpBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces the same output as the standalone HTML builder, but
also generates <a class="reference external" href="http://live.gnome.org/devhelp">GNOME Devhelp</a>
support file that allows the GNOME Devhelp reader to view them.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">devhelp</span></tt>.</p>
</dd></dl>
<span class="target" id="module-sphinx.builders.epub"></span><dl class="class">
<dt id="sphinx.builders.epub.EpubBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.epub.</tt><tt class="descname">EpubBuilder</tt><a class="headerlink" href="#sphinx.builders.epub.EpubBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces the same output as the standalone HTML builder, but
also generates an <em>epub</em> file for ebook readers. See <a class="reference internal" href="faq.html#epub-faq"><em>Epub info</em></a> for
details about it. For definition of the epub format, have a look at
<a class="reference external" href="http://www.idpf.org/specs.htm">http://www.idpf.org/specs.htm</a> or <a class="reference external" href="http://en.wikipedia.org/wiki/EPUB">http://en.wikipedia.org/wiki/EPUB</a>.</p>
<p>Some ebook readers do not show the link targets of references. Therefore
this builder adds the targets after the link when necessary. The display
of the URLs can be customized by adding CSS rules for the class
<tt class="docutils literal"><span class="pre">link-target</span></tt>.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">epub</span></tt>.</p>
</dd></dl>
<span class="target" id="module-sphinx.builders.latex"></span><dl class="class">
<dt id="sphinx.builders.latex.LaTeXBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.latex.</tt><tt class="descname">LaTeXBuilder</tt><a class="headerlink" href="#sphinx.builders.latex.LaTeXBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces a bunch of LaTeX files in the output directory. You
have to specify which documents are to be included in which LaTeX files via
the <a class="reference internal" href="config.html#confval-latex_documents"><tt class="xref std std-confval docutils literal"><span class="pre">latex_documents</span></tt></a> configuration value. There are a few
configuration values that customize the output of this builder, see the
chapter <a class="reference internal" href="config.html#latex-options"><em>Options for LaTeX output</em></a> for details.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The produced LaTeX file uses several LaTeX packages that may not be
present in a “minimal” TeX distribution installation. For TeXLive,
the following packages need to be installed:</p>
<ul class="last simple">
<li>latex-recommended</li>
<li>latex-extra</li>
<li>fonts-recommended</li>
</ul>
</div>
<p>Its name is <tt class="docutils literal"><span class="pre">latex</span></tt>.</p>
</dd></dl>
<p>Note that a direct PDF builder using ReportLab is available in <a class="reference external" href="http://rst2pdf.googlecode.com">rst2pdf</a> version 0.12 or greater. You need to add
<tt class="docutils literal"><span class="pre">'rst2pdf.pdfbuilder'</span></tt> to your <a class="reference internal" href="config.html#confval-extensions"><tt class="xref std std-confval docutils literal"><span class="pre">extensions</span></tt></a> to enable it, its name is
<tt class="docutils literal"><span class="pre">pdf</span></tt>. Refer to the <a class="reference external" href="http://lateral.netmanagers.com.ar/static/manual.pdf">rst2pdf manual</a> for details.</p>
<span class="target" id="module-sphinx.builders.text"></span><dl class="class">
<dt id="sphinx.builders.text.TextBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.text.</tt><tt class="descname">TextBuilder</tt><a class="headerlink" href="#sphinx.builders.text.TextBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces a text file for each reST file – this is almost the
same as the reST source, but with much of the markup stripped for better
readability.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">text</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.4.</span></p>
</dd></dl>
<span class="target" id="module-sphinx.builders.manpage"></span><dl class="class">
<dt id="sphinx.builders.manpage.ManualPageBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.manpage.</tt><tt class="descname">ManualPageBuilder</tt><a class="headerlink" href="#sphinx.builders.manpage.ManualPageBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces manual pages in the groff format. You have to specify
which documents are to be included in which manual pages via the
<a class="reference internal" href="config.html#confval-man_pages"><tt class="xref std std-confval docutils literal"><span class="pre">man_pages</span></tt></a> configuration value.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">man</span></tt>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This builder requires the docutils manual page writer, which is only
available as of docutils 0.6.</p>
</div>
<p class="versionadded">
<span class="versionmodified">New in version 1.0.</span></p>
</dd></dl>
<span class="target" id="module-sphinx.builders.texinfo"></span><dl class="class">
<dt id="sphinx.builders.texinfo.TexinfoBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.texinfo.</tt><tt class="descname">TexinfoBuilder</tt><a class="headerlink" href="#sphinx.builders.texinfo.TexinfoBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces Texinfo files that can be processed into Info files by
the <strong class="program">makeinfo</strong> program. You have to specify which documents are to
be included in which Texinfo files via the <a class="reference internal" href="config.html#confval-texinfo_documents"><tt class="xref std std-confval docutils literal"><span class="pre">texinfo_documents</span></tt></a>
configuration value.</p>
<p>The Info format is the basis of the on-line help system used by GNU Emacs and
the terminal-based program <strong class="program">info</strong>. See <a class="reference internal" href="faq.html#texinfo-faq"><em>Texinfo info</em></a> for more
details. The Texinfo format is the official documentation system used by the
GNU project. More information on Texinfo can be found at
<a class="reference external" href="http://www.gnu.org/software/texinfo/">http://www.gnu.org/software/texinfo/</a>.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">texinfo</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.1.</span></p>
</dd></dl>
<dl class="class">
<dt id="sphinx.builders.html.SerializingHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">SerializingHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.SerializingHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder uses a module that implements the Python serialization API
(<cite>pickle</cite>, <cite>simplejson</cite>, <cite>phpserialize</cite>, and others) to dump the generated
HTML documentation. The pickle builder is a subclass of it.</p>
<p>A concrete subclass of this builder serializing to the <a class="reference external" href="http://pypi.python.org/pypi/phpserialize">PHP serialization</a>
format could look like this:</p>
<div class="highlight-python"><pre>import phpserialize
class PHPSerializedBuilder(SerializingHTMLBuilder):
name = 'phpserialized'
implementation = phpserialize
out_suffix = '.file.phpdump'
globalcontext_filename = 'globalcontext.phpdump'
searchindex_filename = 'searchindex.phpdump'</pre>
</div>
<dl class="attribute">
<dt id="sphinx.builders.html.SerializingHTMLBuilder.implementation">
<tt class="descname">implementation</tt><a class="headerlink" href="#sphinx.builders.html.SerializingHTMLBuilder.implementation" title="Permalink to this definition">¶</a></dt>
<dd><p>A module that implements <cite>dump()</cite>, <cite>load()</cite>, <cite>dumps()</cite> and <cite>loads()</cite>
functions that conform to the functions with the same names from the
pickle module. Known modules implementing this interface are
<cite>simplejson</cite> (or <cite>json</cite> in Python 2.6), <cite>phpserialize</cite>, <cite>plistlib</cite>,
and others.</p>
</dd></dl>
<dl class="attribute">
<dt id="sphinx.builders.html.SerializingHTMLBuilder.out_suffix">
<tt class="descname">out_suffix</tt><a class="headerlink" href="#sphinx.builders.html.SerializingHTMLBuilder.out_suffix" title="Permalink to this definition">¶</a></dt>
<dd><p>The suffix for all regular files.</p>
</dd></dl>
<dl class="attribute">
<dt id="sphinx.builders.html.SerializingHTMLBuilder.globalcontext_filename">
<tt class="descname">globalcontext_filename</tt><a class="headerlink" href="#sphinx.builders.html.SerializingHTMLBuilder.globalcontext_filename" title="Permalink to this definition">¶</a></dt>
<dd><p>The filename for the file that contains the “global context”. This
is a dict with some general configuration values such as the name
of the project.</p>
</dd></dl>
<dl class="attribute">
<dt id="sphinx.builders.html.SerializingHTMLBuilder.searchindex_filename">
<tt class="descname">searchindex_filename</tt><a class="headerlink" href="#sphinx.builders.html.SerializingHTMLBuilder.searchindex_filename" title="Permalink to this definition">¶</a></dt>
<dd><p>The filename for the search index Sphinx generates.</p>
</dd></dl>
<p>See <a class="reference internal" href="#serialization-details"><em>Serialization builder details</em></a> for details about the output format.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
</dd></dl>
<dl class="class">
<dt id="sphinx.builders.html.PickleHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">PickleHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.PickleHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces a directory with pickle files containing mostly HTML
fragments and TOC information, for use of a web application (or custom
postprocessing tool) that doesn’t use the standard HTML templates.</p>
<p>See <a class="reference internal" href="#serialization-details"><em>Serialization builder details</em></a> for details about the output format.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">pickle</span></tt>. (The old name <tt class="docutils literal"><span class="pre">web</span></tt> still works as well.)</p>
<p>The file suffix is <tt class="docutils literal"><span class="pre">.fpickle</span></tt>. The global context is called
<tt class="docutils literal"><span class="pre">globalcontext.pickle</span></tt>, the search index <tt class="docutils literal"><span class="pre">searchindex.pickle</span></tt>.</p>
</dd></dl>
<dl class="class">
<dt id="sphinx.builders.html.JSONHTMLBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.html.</tt><tt class="descname">JSONHTMLBuilder</tt><a class="headerlink" href="#sphinx.builders.html.JSONHTMLBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces a directory with JSON files containing mostly HTML
fragments and TOC information, for use of a web application (or custom
postprocessing tool) that doesn’t use the standard HTML templates.</p>
<p>See <a class="reference internal" href="#serialization-details"><em>Serialization builder details</em></a> for details about the output format.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">json</span></tt>.</p>
<p>The file suffix is <tt class="docutils literal"><span class="pre">.fjson</span></tt>. The global context is called
<tt class="docutils literal"><span class="pre">globalcontext.json</span></tt>, the search index <tt class="docutils literal"><span class="pre">searchindex.json</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
</dd></dl>
<span class="target" id="module-sphinx.builders.gettext"></span><dl class="class">
<dt id="sphinx.builders.gettext.MessageCatalogBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.gettext.</tt><tt class="descname">MessageCatalogBuilder</tt><a class="headerlink" href="#sphinx.builders.gettext.MessageCatalogBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces gettext-style message catalogs. Each top-level file or
subdirectory grows a single <tt class="docutils literal"><span class="pre">.pot</span></tt> catalog template.</p>
<p>See the documentation on <a class="reference internal" href="intl.html#intl"><em>Internationalization</em></a> for further reference.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">gettext</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.1.</span></p>
</dd></dl>
<span class="target" id="module-sphinx.builders.changes"></span><dl class="class">
<dt id="sphinx.builders.changes.ChangesBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.changes.</tt><tt class="descname">ChangesBuilder</tt><a class="headerlink" href="#sphinx.builders.changes.ChangesBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder produces an HTML overview of all <a class="reference internal" href="markup/para.html#directive-versionadded" title="versionadded directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">versionadded</span></tt></a>,
<a class="reference internal" href="markup/para.html#directive-versionchanged" title="versionchanged directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">versionchanged</span></tt></a> and <a class="reference internal" href="markup/para.html#directive-deprecated" title="deprecated directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">deprecated</span></tt></a> directives for the current
<a class="reference internal" href="config.html#confval-version"><tt class="xref std std-confval docutils literal"><span class="pre">version</span></tt></a>. This is useful to generate a ChangeLog file, for
example.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">changes</span></tt>.</p>
</dd></dl>
<span class="target" id="module-sphinx.builders.linkcheck"></span><dl class="class">
<dt id="sphinx.builders.linkcheck.CheckExternalLinksBuilder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.linkcheck.</tt><tt class="descname">CheckExternalLinksBuilder</tt><a class="headerlink" href="#sphinx.builders.linkcheck.CheckExternalLinksBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>This builder scans all documents for external links, tries to open them with
<tt class="xref py py-mod docutils literal"><span class="pre">urllib2</span></tt>, and writes an overview which ones are broken and redirected
to standard output and to <tt class="file docutils literal"><span class="pre">output.txt</span></tt> in the output directory.</p>
<p>Its name is <tt class="docutils literal"><span class="pre">linkcheck</span></tt>.</p>
</dd></dl>
<p>Built-in Sphinx extensions that offer more builders are:</p>
<ul class="simple">
<li><a class="reference internal" href="ext/doctest.html#module-sphinx.ext.doctest" title="sphinx.ext.doctest: Test snippets in the documentation."><tt class="xref py py-mod docutils literal"><span class="pre">doctest</span></tt></a></li>
<li><a class="reference internal" href="ext/coverage.html#module-sphinx.ext.coverage" title="sphinx.ext.coverage: Check Python modules and C API for coverage in the documentation."><tt class="xref py py-mod docutils literal"><span class="pre">coverage</span></tt></a></li>
</ul>
<div class="section" id="serialization-builder-details">
<span id="serialization-details"></span><h2>Serialization builder details<a class="headerlink" href="#serialization-builder-details" title="Permalink to this headline">¶</a></h2>
<p>All serialization builders outputs one file per source file and a few special
files. They also copy the reST source files in the directory <tt class="docutils literal"><span class="pre">_sources</span></tt>
under the output directory.</p>
<p>The <a class="reference internal" href="#sphinx.builders.html.PickleHTMLBuilder" title="sphinx.builders.html.PickleHTMLBuilder"><tt class="xref py py-class docutils literal"><span class="pre">PickleHTMLBuilder</span></tt></a> is a builtin subclass that implements the pickle
serialization interface.</p>
<p>The files per source file have the extensions of
<a class="reference internal" href="#sphinx.builders.html.SerializingHTMLBuilder.out_suffix" title="sphinx.builders.html.SerializingHTMLBuilder.out_suffix"><tt class="xref py py-attr docutils literal"><span class="pre">out_suffix</span></tt></a>, and are arranged in directories
just as the source files are. They unserialize to a dictionary (or dictionary
like structure) with these keys:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">body</span></tt></dt>
<dd>The HTML “body” (that is, the HTML rendering of the source file), as rendered
by the HTML translator.</dd>
<dt><tt class="docutils literal"><span class="pre">title</span></tt></dt>
<dd>The title of the document, as HTML (may contain markup).</dd>
<dt><tt class="docutils literal"><span class="pre">toc</span></tt></dt>
<dd>The table of contents for the file, rendered as an HTML <tt class="docutils literal"><span class="pre"><ul></span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">display_toc</span></tt></dt>
<dd>A boolean that is <tt class="docutils literal"><span class="pre">True</span></tt> if the <tt class="docutils literal"><span class="pre">toc</span></tt> contains more than one entry.</dd>
<dt><tt class="docutils literal"><span class="pre">current_page_name</span></tt></dt>
<dd>The document name of the current file.</dd>
<dt><tt class="docutils literal"><span class="pre">parents</span></tt>, <tt class="docutils literal"><span class="pre">prev</span></tt> and <tt class="docutils literal"><span class="pre">next</span></tt></dt>
<dd>Information about related chapters in the TOC tree. Each relation is a
dictionary with the keys <tt class="docutils literal"><span class="pre">link</span></tt> (HREF for the relation) and <tt class="docutils literal"><span class="pre">title</span></tt>
(title of the related document, as HTML). <tt class="docutils literal"><span class="pre">parents</span></tt> is a list of
relations, while <tt class="docutils literal"><span class="pre">prev</span></tt> and <tt class="docutils literal"><span class="pre">next</span></tt> are a single relation.</dd>
<dt><tt class="docutils literal"><span class="pre">sourcename</span></tt></dt>
<dd>The name of the source file under <tt class="docutils literal"><span class="pre">_sources</span></tt>.</dd>
</dl>
<p>The special files are located in the root output directory. They are:</p>
<dl class="docutils">
<dt><a class="reference internal" href="#sphinx.builders.html.SerializingHTMLBuilder.globalcontext_filename" title="sphinx.builders.html.SerializingHTMLBuilder.globalcontext_filename"><tt class="xref py py-attr docutils literal"><span class="pre">SerializingHTMLBuilder.globalcontext_filename</span></tt></a></dt>
<dd><p class="first">A pickled dict with these keys:</p>
<dl class="last docutils">
<dt><tt class="docutils literal"><span class="pre">project</span></tt>, <tt class="docutils literal"><span class="pre">copyright</span></tt>, <tt class="docutils literal"><span class="pre">release</span></tt>, <tt class="docutils literal"><span class="pre">version</span></tt></dt>
<dd>The same values as given in the configuration file.</dd>
<dt><tt class="docutils literal"><span class="pre">style</span></tt></dt>
<dd><a class="reference internal" href="config.html#confval-html_style"><tt class="xref std std-confval docutils literal"><span class="pre">html_style</span></tt></a>.</dd>
<dt><tt class="docutils literal"><span class="pre">last_updated</span></tt></dt>
<dd>Date of last build.</dd>
<dt><tt class="docutils literal"><span class="pre">builder</span></tt></dt>
<dd>Name of the used builder, in the case of pickles this is always
<tt class="docutils literal"><span class="pre">'pickle'</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">titles</span></tt></dt>
<dd>A dictionary of all documents’ titles, as HTML strings.</dd>
</dl>
</dd>
<dt><a class="reference internal" href="#sphinx.builders.html.SerializingHTMLBuilder.searchindex_filename" title="sphinx.builders.html.SerializingHTMLBuilder.searchindex_filename"><tt class="xref py py-attr docutils literal"><span class="pre">SerializingHTMLBuilder.searchindex_filename</span></tt></a></dt>
<dd><p class="first">An index that can be used for searching the documentation. It is a pickled
list with these entries:</p>
<ul class="last simple">
<li>A list of indexed docnames.</li>
<li>A list of document titles, as HTML strings, in the same order as the first
list.</li>
<li>A dict mapping word roots (processed by an English-language stemmer) to a
list of integers, which are indices into the first list.</li>
</ul>
</dd>
<dt><tt class="docutils literal"><span class="pre">environment.pickle</span></tt></dt>
<dd><p class="first">The build environment. This is always a pickle file, independent of the
builder and a copy of the environment that was used when the builder was
started.</p>
<div class="admonition-todo admonition" id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Document common members.</p>
</div>
<p class="last">Unlike the other pickle files this pickle file requires that the <tt class="docutils literal"><span class="pre">sphinx</span></tt>
package is available on unpickling.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="config.html" title="The build configuration file"
>next</a> |</li>
<li class="right" >
<a href="domains.html" title="Sphinx Domains"
>previous</a> |</li>
<li><a href="index.html">Sphinx home</a> | </li>
<li><a href="contents.html">Documentation</a>
»</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2011, Georg Brandl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Mageia
>
4
>
i586
>
media
>
core-release
>
by-pkgid
>
c95717a2237548a7bdaddf39c85b0f0f
>
files
>
91
