<!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>Templating — 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="Sphinx Extensions" href="extensions.html" />
<link rel="prev" title="HTML theming support" href="theming.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="extensions.html" title="Sphinx Extensions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="theming.html" title="HTML theming support"
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="#">Templating</a><ul>
<li><a class="reference internal" href="#do-i-need-to-use-sphinx-templates-to-produce-html">Do I need to use Sphinx’ templates to produce HTML?</a></li>
<li><a class="reference internal" href="#jinja-sphinx-templating-primer">Jinja/Sphinx Templating Primer</a></li>
<li><a class="reference internal" href="#working-with-the-builtin-templates">Working with the builtin templates</a><ul>
<li><a class="reference internal" href="#blocks">Blocks</a></li>
<li><a class="reference internal" href="#configuration-variables">Configuration Variables</a></li>
<li><a class="reference internal" href="#helper-functions">Helper Functions</a></li>
<li><a class="reference internal" href="#global-variables">Global Variables</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="theming.html"
title="previous chapter">HTML theming support</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="extensions.html"
title="next chapter">Sphinx Extensions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/templating.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="templating">
<span id="id1"></span><h1>Templating<a class="headerlink" href="#templating" title="Permalink to this headline">¶</a></h1>
<p>Sphinx uses the <a class="reference external" href="http://jinja.pocoo.org">Jinja</a> templating engine for its HTML
templates. Jinja is a text-based engine, and inspired by Django templates, so
anyone having used Django will already be familiar with it. It also has
excellent documentation for those who need to make themselves familiar with it.</p>
<div class="section" id="do-i-need-to-use-sphinx-templates-to-produce-html">
<h2>Do I need to use Sphinx’ templates to produce HTML?<a class="headerlink" href="#do-i-need-to-use-sphinx-templates-to-produce-html" title="Permalink to this headline">¶</a></h2>
<p>No. You have several other options:</p>
<ul class="simple">
<li>You can write a <a class="reference internal" href="ext/appapi.html#sphinx.application.TemplateBridge" title="sphinx.application.TemplateBridge"><tt class="xref py py-class docutils literal"><span class="pre">TemplateBridge</span></tt></a> subclass that
calls your template engine of choice, and set the <a class="reference internal" href="config.html#confval-template_bridge"><tt class="xref std std-confval docutils literal"><span class="pre">template_bridge</span></tt></a>
configuration value accordingly.</li>
<li>You can <a class="reference internal" href="ext/builderapi.html#writing-builders"><em>write a custom builder</em></a> that derives from
<a class="reference internal" href="builders.html#sphinx.builders.html.StandaloneHTMLBuilder" title="sphinx.builders.html.StandaloneHTMLBuilder"><tt class="xref py py-class docutils literal"><span class="pre">StandaloneHTMLBuilder</span></tt></a> and calls your template
engine of choice.</li>
<li>You can use the <a class="reference internal" href="builders.html#sphinx.builders.html.PickleHTMLBuilder" title="sphinx.builders.html.PickleHTMLBuilder"><tt class="xref py py-class docutils literal"><span class="pre">PickleHTMLBuilder</span></tt></a> that produces
pickle files with the page contents, and postprocess them using a custom tool,
or use them in your Web application.</li>
</ul>
</div>
<div class="section" id="jinja-sphinx-templating-primer">
<h2>Jinja/Sphinx Templating Primer<a class="headerlink" href="#jinja-sphinx-templating-primer" title="Permalink to this headline">¶</a></h2>
<p>The default templating language in Sphinx is Jinja. It’s Django/Smarty inspired
and easy to understand. The most important concept in Jinja is <em class="dfn">template
inheritance</em>, which means that you can overwrite only specific blocks within a
template, customizing it while also keeping the changes at a minimum.</p>
<p>To customize the output of your documentation you can override all the templates
(both the layout templates and the child templates) by adding files with the
same name as the original filename into the template directory of the structure
the Sphinx quickstart generated for you.</p>
<p>Sphinx will look for templates in the folders of <a class="reference internal" href="config.html#confval-templates_path"><tt class="xref std std-confval docutils literal"><span class="pre">templates_path</span></tt></a>
first, and if it can’t find the template it’s looking for there, it falls back
to the selected theme’s templates.</p>
<p>A template contains <strong>variables</strong>, which are replaced with values when the
template is evaluated, <strong>tags</strong>, which control the logic of the template and
<strong>blocks</strong> which are used for template inheritance.</p>
<p>Sphinx’ <em>basic</em> theme provides base templates with a couple of blocks it will
fill with data. These are located in the <tt class="file docutils literal"><span class="pre">themes/basic</span></tt> subdirectory of
the Sphinx installation directory, and used by all builtin Sphinx themes.
Templates with the same name in the <a class="reference internal" href="config.html#confval-templates_path"><tt class="xref std std-confval docutils literal"><span class="pre">templates_path</span></tt></a> override templates
supplied by the selected theme.</p>
<p>For example, to add a new link to the template area containing related links all
you have to do is to add a new template called <tt class="docutils literal"><span class="pre">layout.html</span></tt> with the
following contents:</p>
<div class="highlight-html+jinja"><pre>{% extends "!layout.html" %}
{% block rootrellink %}
<li><a href="http://project.invalid/">Project Homepage</a> &raquo;</li>
{{ super() }}
{% endblock %}</pre>
</div>
<p>By prefixing the name of the overridden template with an exclamation mark,
Sphinx will load the layout template from the underlying HTML theme.</p>
<p><strong>Important</strong>: If you override a block, call <tt class="docutils literal"><span class="pre">{{</span> <span class="pre">super()</span> <span class="pre">}}</span></tt> somewhere to
render the block’s content in the extended template – unless you don’t want
that content to show up.</p>
</div>
<div class="section" id="working-with-the-builtin-templates">
<h2>Working with the builtin templates<a class="headerlink" href="#working-with-the-builtin-templates" title="Permalink to this headline">¶</a></h2>
<p>The builtin <strong>basic</strong> theme supplies the templates that all builtin Sphinx
themes are based on. It has the following elements you can override or use:</p>
<div class="section" id="blocks">
<h3>Blocks<a class="headerlink" href="#blocks" title="Permalink to this headline">¶</a></h3>
<p>The following blocks exist in the <tt class="docutils literal"><span class="pre">layout.html</span></tt> template:</p>
<dl class="docutils">
<dt><cite>doctype</cite></dt>
<dd>The doctype of the output format. By default this is XHTML 1.0 Transitional
as this is the closest to what Sphinx and Docutils generate and it’s a good
idea not to change it unless you want to switch to HTML 5 or a different but
compatible XHTML doctype.</dd>
<dt><cite>linktags</cite></dt>
<dd>This block adds a couple of <tt class="docutils literal"><span class="pre"><link></span></tt> tags to the head section of the
template.</dd>
<dt><cite>extrahead</cite></dt>
<dd>This block is empty by default and can be used to add extra contents into
the <tt class="docutils literal"><span class="pre"><head></span></tt> tag of the generated HTML file. This is the right place to
add references to JavaScript or extra CSS files.</dd>
<dt><cite>relbar1</cite> / <cite>relbar2</cite></dt>
<dd><p class="first">This block contains the <em>relation bar</em>, the list of related links (the
parent documents on the left, and the links to index, modules etc. on the
right). <cite>relbar1</cite> appears before the document, <cite>relbar2</cite> after the
document. By default, both blocks are filled; to show the relbar only
before the document, you would override <cite>relbar2</cite> like this:</p>
<div class="last highlight-html+jinja"><pre>{% block relbar2 %}{% endblock %}</pre>
</div>
</dd>
<dt><cite>rootrellink</cite> / <cite>relbaritems</cite></dt>
<dd>Inside the relbar there are three sections: The <cite>rootrellink</cite>, the links
from the documentation and the custom <cite>relbaritems</cite>. The <cite>rootrellink</cite> is a
block that by default contains a list item pointing to the master document
by default, the <cite>relbaritems</cite> is an empty block. If you override them to
add extra links into the bar make sure that they are list items and end with
the <a class="reference internal" href="#reldelim1" title="reldelim1"><tt class="xref py py-data docutils literal"><span class="pre">reldelim1</span></tt></a>.</dd>
<dt><cite>document</cite></dt>
<dd>The contents of the document itself. It contains the block “body” where the
individual content is put by subtemplates like <tt class="docutils literal"><span class="pre">page.html</span></tt>.</dd>
<dt><cite>sidebar1</cite> / <cite>sidebar2</cite></dt>
<dd><p class="first">A possible location for a sidebar. <cite>sidebar1</cite> appears before the document
and is empty by default, <cite>sidebar2</cite> after the document and contains the
default sidebar. If you want to swap the sidebar location override this and
call the <cite>sidebar</cite> helper:</p>
<div class="highlight-html+jinja"><pre>{% block sidebar1 %}{{ sidebar() }}{% endblock %}
{% block sidebar2 %}{% endblock %}</pre>
</div>
<p class="last">(The <cite>sidebar2</cite> location for the sidebar is needed by the <tt class="docutils literal"><span class="pre">sphinxdoc.css</span></tt>
stylesheet, for example.)</p>
</dd>
<dt><cite>sidebarlogo</cite></dt>
<dd>The logo location within the sidebar. Override this if you want to place
some content at the top of the sidebar.</dd>
<dt><cite>footer</cite></dt>
<dd>The block for the footer div. If you want a custom footer or markup before
or after it, override this one.</dd>
</dl>
<p>The following four blocks are <em>only</em> used for pages that do not have assigned a
list of custom sidebars in the <a class="reference internal" href="config.html#confval-html_sidebars"><tt class="xref std std-confval docutils literal"><span class="pre">html_sidebars</span></tt></a> config value. Their use
is deprecated in favor of separate sidebar templates, which can be included via
<a class="reference internal" href="config.html#confval-html_sidebars"><tt class="xref std std-confval docutils literal"><span class="pre">html_sidebars</span></tt></a>.</p>
<dl class="docutils">
<dt><cite>sidebartoc</cite></dt>
<dd><p class="first">The table of contents within the sidebar.</p>
<p class="last deprecated">
<span class="versionmodified">Deprecated since version 1.0.</span></p>
</dd>
<dt><cite>sidebarrel</cite></dt>
<dd><p class="first">The relation links (previous, next document) within the sidebar.</p>
<p class="last deprecated">
<span class="versionmodified">Deprecated since version 1.0.</span></p>
</dd>
<dt><cite>sidebarsourcelink</cite></dt>
<dd><p class="first">The “Show source” link within the sidebar (normally only shown if this is
enabled by <a class="reference internal" href="config.html#confval-html_show_sourcelink"><tt class="xref std std-confval docutils literal"><span class="pre">html_show_sourcelink</span></tt></a>).</p>
<p class="last deprecated">
<span class="versionmodified">Deprecated since version 1.0.</span></p>
</dd>
<dt><cite>sidebarsearch</cite></dt>
<dd><p class="first">The search box within the sidebar. Override this if you want to place some
content at the bottom of the sidebar.</p>
<p class="last deprecated">
<span class="versionmodified">Deprecated since version 1.0.</span></p>
</dd>
</dl>
</div>
<div class="section" id="configuration-variables">
<h3>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h3>
<p>Inside templates you can set a couple of variables used by the layout template
using the <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">set</span> <span class="pre">%}</span></tt> tag:</p>
<dl class="data">
<dt id="reldelim1">
<tt class="descname">reldelim1</tt><a class="headerlink" href="#reldelim1" title="Permalink to this definition">¶</a></dt>
<dd><p>The delimiter for the items on the left side of the related bar. This
defaults to <tt class="docutils literal"><span class="pre">'</span> <span class="pre">&raquo;'</span></tt> Each item in the related bar ends with the value
of this variable.</p>
</dd></dl>
<dl class="data">
<dt id="reldelim2">
<tt class="descname">reldelim2</tt><a class="headerlink" href="#reldelim2" title="Permalink to this definition">¶</a></dt>
<dd><p>The delimiter for the items on the right side of the related bar. This
defaults to <tt class="docutils literal"><span class="pre">'</span> <span class="pre">|'</span></tt>. Each item except of the last one in the related bar
ends with the value of this variable.</p>
</dd></dl>
<p>Overriding works like this:</p>
<div class="highlight-html+jinja"><pre>{% extends "!layout.html" %}
{% set reldelim1 = ' &gt;' %}</pre>
</div>
<dl class="data">
<dt id="script_files">
<tt class="descname">script_files</tt><a class="headerlink" href="#script_files" title="Permalink to this definition">¶</a></dt>
<dd><p>Add additional script files here, like this:</p>
<div class="highlight-html+jinja"><pre>{% set script_files = script_files + ["_static/myscript.js"] %}</pre>
</div>
</dd></dl>
<dl class="data">
<dt id="css_files">
<tt class="descname">css_files</tt><a class="headerlink" href="#css_files" title="Permalink to this definition">¶</a></dt>
<dd><p>Similar to <a class="reference internal" href="#script_files" title="script_files"><tt class="xref py py-data docutils literal"><span class="pre">script_files</span></tt></a>, for CSS files.</p>
</dd></dl>
</div>
<div class="section" id="helper-functions">
<h3>Helper Functions<a class="headerlink" href="#helper-functions" title="Permalink to this headline">¶</a></h3>
<p>Sphinx provides various Jinja functions as helpers in the template. You can use
them to generate links or output multiply used elements.</p>
<dl class="function">
<dt id="pathto">
<tt class="descname">pathto</tt><big>(</big><em>document</em><big>)</big><a class="headerlink" href="#pathto" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the path to a Sphinx document as a URL. Use this to refer to built
documents.</p>
</dd></dl>
<dl class="function">
<dt>
<tt class="descname">pathto</tt><big>(</big><em>file</em>, <em>1</em><big>)</big></dt>
<dd><p>Return the path to a <em>file</em> which is a filename relative to the root of the
generated output. Use this to refer to static files.</p>
</dd></dl>
<dl class="function">
<dt id="hasdoc">
<tt class="descname">hasdoc</tt><big>(</big><em>document</em><big>)</big><a class="headerlink" href="#hasdoc" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if a document with the name <em>document</em> exists.</p>
</dd></dl>
<dl class="function">
<dt id="sidebar">
<tt class="descname">sidebar</tt><big>(</big><big>)</big><a class="headerlink" href="#sidebar" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the rendered sidebar.</p>
</dd></dl>
<dl class="function">
<dt id="relbar">
<tt class="descname">relbar</tt><big>(</big><big>)</big><a class="headerlink" href="#relbar" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the rendered relation bar.</p>
</dd></dl>
</div>
<div class="section" id="global-variables">
<h3>Global Variables<a class="headerlink" href="#global-variables" title="Permalink to this headline">¶</a></h3>
<p>These global variables are available in every template and are safe to use.
There are more, but most of them are an implementation detail and might change
in the future.</p>
<dl class="data">
<dt id="builder">
<tt class="descname">builder</tt><a class="headerlink" href="#builder" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the builder (e.g. <tt class="docutils literal"><span class="pre">html</span></tt> or <tt class="docutils literal"><span class="pre">htmlhelp</span></tt>).</p>
</dd></dl>
<dl class="data">
<dt id="copyright">
<tt class="descname">copyright</tt><a class="headerlink" href="#copyright" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-copyright"><tt class="xref std std-confval docutils literal"><span class="pre">copyright</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="docstitle">
<tt class="descname">docstitle</tt><a class="headerlink" href="#docstitle" title="Permalink to this definition">¶</a></dt>
<dd><p>The title of the documentation (the value of <a class="reference internal" href="config.html#confval-html_title"><tt class="xref std std-confval docutils literal"><span class="pre">html_title</span></tt></a>).</p>
</dd></dl>
<dl class="data">
<dt id="embedded">
<tt class="descname">embedded</tt><a class="headerlink" href="#embedded" title="Permalink to this definition">¶</a></dt>
<dd><p>True if the built HTML is meant to be embedded in some viewing application
that handles navigation, not the web browser, such as for HTML help or Qt
help formats. In this case, the sidebar is not included.</p>
</dd></dl>
<dl class="data">
<dt id="favicon">
<tt class="descname">favicon</tt><a class="headerlink" href="#favicon" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to the HTML favicon in the static path, or <tt class="docutils literal"><span class="pre">''</span></tt>.</p>
</dd></dl>
<dl class="data">
<dt id="file_suffix">
<tt class="descname">file_suffix</tt><a class="headerlink" href="#file_suffix" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of the builder’s <a class="reference internal" href="builders.html#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>
attribute, i.e. the file name extension that the output files will get. For
a standard HTML builder, this is usually <tt class="docutils literal"><span class="pre">.html</span></tt>.</p>
</dd></dl>
<dl class="data">
<dt id="has_source">
<tt class="descname">has_source</tt><a class="headerlink" href="#has_source" title="Permalink to this definition">¶</a></dt>
<dd><p>True if the reST document sources are copied (if <a class="reference internal" href="config.html#confval-html_copy_source"><tt class="xref std std-confval docutils literal"><span class="pre">html_copy_source</span></tt></a>
is true).</p>
</dd></dl>
<dl class="data">
<dt id="last_updated">
<tt class="descname">last_updated</tt><a class="headerlink" href="#last_updated" title="Permalink to this definition">¶</a></dt>
<dd><p>The build date.</p>
</dd></dl>
<dl class="data">
<dt id="logo">
<tt class="descname">logo</tt><a class="headerlink" href="#logo" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to the HTML logo image in the static path, or <tt class="docutils literal"><span class="pre">''</span></tt>.</p>
</dd></dl>
<dl class="data">
<dt id="master_doc">
<tt class="descname">master_doc</tt><a class="headerlink" href="#master_doc" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-master_doc"><tt class="xref std std-confval docutils literal"><span class="pre">master_doc</span></tt></a>, for usage with <a class="reference internal" href="#pathto" title="pathto"><tt class="xref py py-func docutils literal"><span class="pre">pathto()</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="next">
<tt class="descname">next</tt><a class="headerlink" href="#next" title="Permalink to this definition">¶</a></dt>
<dd><p>The next document for the navigation. This variable is either false or has
two attributes <cite>link</cite> and <cite>title</cite>. The title contains HTML markup. For
example, to generate a link to the next page, you can use this snippet:</p>
<div class="highlight-html+jinja"><pre>{% if next %}
<a href="{{ next.link|e }}">{{ next.title }}</a>
{% endif %}</pre>
</div>
</dd></dl>
<dl class="data">
<dt id="pagename">
<tt class="descname">pagename</tt><a class="headerlink" href="#pagename" title="Permalink to this definition">¶</a></dt>
<dd><p>The “page name” of the current file, i.e. either the document name if the
file is generated from a reST source, or the equivalent hierarchical name
relative to the output directory (<tt class="docutils literal"><span class="pre">[directory/]filename_without_extension</span></tt>).</p>
</dd></dl>
<dl class="data">
<dt id="parents">
<tt class="descname">parents</tt><a class="headerlink" href="#parents" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of parent documents for navigation, structured like the <a class="reference internal" href="#next" title="next"><tt class="xref py py-data docutils literal"><span class="pre">next</span></tt></a>
item.</p>
</dd></dl>
<dl class="data">
<dt id="prev">
<tt class="descname">prev</tt><a class="headerlink" href="#prev" title="Permalink to this definition">¶</a></dt>
<dd><p>Like <a class="reference internal" href="#next" title="next"><tt class="xref py py-data docutils literal"><span class="pre">next</span></tt></a>, but for the previous page.</p>
</dd></dl>
<dl class="data">
<dt id="project">
<tt class="descname">project</tt><a class="headerlink" href="#project" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-project"><tt class="xref std std-confval docutils literal"><span class="pre">project</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="release">
<tt class="descname">release</tt><a class="headerlink" href="#release" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-release"><tt class="xref std std-confval docutils literal"><span class="pre">release</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="rellinks">
<tt class="descname">rellinks</tt><a class="headerlink" href="#rellinks" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of links to put at the left side of the relbar, next to “next” and
“prev”. This usually contains links to the general index and other indices,
such as the Python module index. If you add something yourself, it must be a
tuple <tt class="docutils literal"><span class="pre">(pagename,</span> <span class="pre">link</span> <span class="pre">title,</span> <span class="pre">accesskey,</span> <span class="pre">link</span> <span class="pre">text)</span></tt>.</p>
</dd></dl>
<dl class="data">
<dt id="shorttitle">
<tt class="descname">shorttitle</tt><a class="headerlink" href="#shorttitle" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-html_short_title"><tt class="xref std std-confval docutils literal"><span class="pre">html_short_title</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="show_source">
<tt class="descname">show_source</tt><a class="headerlink" href="#show_source" title="Permalink to this definition">¶</a></dt>
<dd><p>True if <a class="reference internal" href="config.html#confval-html_show_sourcelink"><tt class="xref std std-confval docutils literal"><span class="pre">html_show_sourcelink</span></tt></a> is true.</p>
</dd></dl>
<dl class="data">
<dt id="sphinx_version">
<tt class="descname">sphinx_version</tt><a class="headerlink" href="#sphinx_version" title="Permalink to this definition">¶</a></dt>
<dd><p>The version of Sphinx used to build.</p>
</dd></dl>
<dl class="data">
<dt id="style">
<tt class="descname">style</tt><a class="headerlink" href="#style" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the main stylesheet, as given by the theme or
<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>.</p>
</dd></dl>
<dl class="data">
<dt id="title">
<tt class="descname">title</tt><a class="headerlink" href="#title" title="Permalink to this definition">¶</a></dt>
<dd><p>The title of the current document, as used in the <tt class="docutils literal"><span class="pre"><title></span></tt> tag.</p>
</dd></dl>
<dl class="data">
<dt id="use_opensearch">
<tt class="descname">use_opensearch</tt><a class="headerlink" href="#use_opensearch" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-html_use_opensearch"><tt class="xref std std-confval docutils literal"><span class="pre">html_use_opensearch</span></tt></a>.</p>
</dd></dl>
<dl class="data">
<dt id="version">
<tt class="descname">version</tt><a class="headerlink" href="#version" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <a class="reference internal" href="config.html#confval-version"><tt class="xref std std-confval docutils literal"><span class="pre">version</span></tt></a>.</p>
</dd></dl>
<p>In addition to these values, there are also all <strong>theme options</strong> available
(prefixed by <tt class="docutils literal"><span class="pre">theme_</span></tt>), as well as the values given by the user in
<a class="reference internal" href="config.html#confval-html_context"><tt class="xref std std-confval docutils literal"><span class="pre">html_context</span></tt></a>.</p>
<p>In documents that are created from source files (as opposed to
automatically-generated files like the module index, or documents that already
are in HTML form), these variables are also available:</p>
<dl class="data">
<dt id="meta">
<tt class="descname">meta</tt><a class="headerlink" href="#meta" title="Permalink to this definition">¶</a></dt>
<dd><p>Document metadata (a dictionary), see <a class="reference internal" href="markup/misc.html#metadata"><em>File-wide metadata</em></a>.</p>
</dd></dl>
<dl class="data">
<dt id="sourcename">
<tt class="descname">sourcename</tt><a class="headerlink" href="#sourcename" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the copied source file for the current document. This is only
nonempty if the <a class="reference internal" href="config.html#confval-html_copy_source"><tt class="xref std std-confval docutils literal"><span class="pre">html_copy_source</span></tt></a> value is true.</p>
</dd></dl>
<dl class="data">
<dt id="toc">
<tt class="descname">toc</tt><a class="headerlink" href="#toc" title="Permalink to this definition">¶</a></dt>
<dd><p>The local table of contents for the current page, rendered as HTML bullet
lists.</p>
</dd></dl>
<dl class="data">
<dt id="toctree">
<tt class="descname">toctree</tt><a class="headerlink" href="#toctree" title="Permalink to this definition">¶</a></dt>
<dd><p>A callable yielding the global TOC tree containing the current page, rendered
as HTML bullet lists. Optional keyword arguments:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">collapse</span></tt> (true by default): if true, all TOC entries that are not
ancestors of the current page are collapsed</li>
<li><tt class="docutils literal"><span class="pre">maxdepth</span></tt> (defaults to the max depth selected in the toctree directive):
the maximum depth of the tree; set it to <tt class="docutils literal"><span class="pre">-1</span></tt> to allow unlimited depth</li>
<li><tt class="docutils literal"><span class="pre">titles_only</span></tt> (false by default): if true, put only toplevel document
titles in the tree</li>
</ul>
</dd></dl>
</div>
</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="extensions.html" title="Sphinx Extensions"
>next</a> |</li>
<li class="right" >
<a href="theming.html" title="HTML theming support"
>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
>
139
