<!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>Writing new builders — Sphinx v1.0.7 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.0.7',
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 v1.0.7 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Sphinx v1.0.7 documentation" href="../index.html" />
<link rel="up" title="Sphinx Extensions" href="../extensions.html" />
<link rel="next" title="sphinx.ext.autodoc – Include documentation from docstrings" href="autodoc.html" />
<link rel="prev" title="Extension API" href="appapi.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="autodoc.html" title="sphinx.ext.autodoc – Include documentation from docstrings"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="appapi.html" title="Extension API"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" accesskey="U">Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="appapi.html"
title="previous chapter">Extension API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="autodoc.html"
title="next chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">sphinx.ext.autodoc</span></tt> – Include documentation from docstrings</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ext/builderapi.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" size="18" />
<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="writing-new-builders">
<span id="writing-builders"></span><h1>Writing new builders<a class="headerlink" href="#writing-new-builders" title="Permalink to this headline">¶</a></h1>
<div class="admonition-todo admonition " id="index-0">
<p class="first admonition-title">Todo</p>
<p class="last">Expand this.</p>
</div>
<dl class="class">
<dt id="sphinx.builders.Builder">
<em class="property">class </em><tt class="descclassname">sphinx.builders.</tt><tt class="descname">Builder</tt><a class="headerlink" href="#sphinx.builders.Builder" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the base class for all builders.</p>
<p>These methods are predefined and will be called from the application:</p>
<dl class="method">
<dt id="sphinx.builders.Builder.get_relative_uri">
<tt class="descname">get_relative_uri</tt><big>(</big><em>from_</em>, <em>to</em>, <em>typ=None</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.get_relative_uri" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a relative URI between two source filenames. May raise
environment.NoUri if there’s no way to return a sensible URI.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.build_all">
<tt class="descname">build_all</tt><big>(</big><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.build_all" title="Permalink to this definition">¶</a></dt>
<dd><p>Build all source files.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.build_specific">
<tt class="descname">build_specific</tt><big>(</big><em>filenames</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.build_specific" title="Permalink to this definition">¶</a></dt>
<dd><p>Only rebuild as much as needed for changes in the <em>filenames</em>.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.build_update">
<tt class="descname">build_update</tt><big>(</big><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.build_update" title="Permalink to this definition">¶</a></dt>
<dd><p>Only rebuild what was changed or added since last build.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.build">
<tt class="descname">build</tt><big>(</big><em>docnames</em>, <em>summary=None</em>, <em>method='update'</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.build" title="Permalink to this definition">¶</a></dt>
<dd><p>Main build method. First updates the environment, and then
calls <tt class="xref py py-meth docutils literal"><span class="pre">write()</span></tt>.</p>
</dd></dl>
<p>These methods can be overridden in concrete builder classes:</p>
<dl class="method">
<dt id="sphinx.builders.Builder.init">
<tt class="descname">init</tt><big>(</big><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.init" title="Permalink to this definition">¶</a></dt>
<dd><p>Load necessary templates and perform initialization. The default
implementation does nothing.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.get_outdated_docs">
<tt class="descname">get_outdated_docs</tt><big>(</big><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.get_outdated_docs" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an iterable of output files that are outdated, or a string
describing what an update build will build.</p>
<p>If the builder does not output individual files corresponding to
source files, return a string here. If it does, return an iterable
of those files that need to be written.</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.get_target_uri">
<tt class="descname">get_target_uri</tt><big>(</big><em>docname</em>, <em>typ=None</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.get_target_uri" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the target URI for a document name (<em>typ</em> can be used to qualify
the link characteristic for individual builders).</p>
</dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.prepare_writing">
<tt class="descname">prepare_writing</tt><big>(</big><em>docnames</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.prepare_writing" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.write_doc">
<tt class="descname">write_doc</tt><big>(</big><em>docname</em>, <em>doctree</em><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.write_doc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="sphinx.builders.Builder.finish">
<tt class="descname">finish</tt><big>(</big><big>)</big><a class="headerlink" href="#sphinx.builders.Builder.finish" title="Permalink to this definition">¶</a></dt>
<dd><p>Finish the building process. The default implementation does nothing.</p>
</dd></dl>
</dd></dl>
</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="autodoc.html" title="sphinx.ext.autodoc – Include documentation from docstrings"
>next</a> |</li>
<li class="right" >
<a href="appapi.html" title="Extension API"
>previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" >Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2011, Georg Brandl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
2b39e69e45f9a0b2b3aece7339c56216
>
files
>
82
