<!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>Sphinx documentation contents — 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="Introduction" href="intro.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="intro.html" title="Introduction"
accesskey="N">next</a> |</li>
<li><a href="index.html">Sphinx home</a> | </li>
<li><a href="#">Documentation</a>
»</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Sphinx documentation contents</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="intro.html"
title="next chapter">Introduction</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contents.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="sphinx-documentation-contents">
<span id="contents"></span><h1>Sphinx documentation contents<a class="headerlink" href="#sphinx-documentation-contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#conversion-from-other-systems">Conversion from other systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#use-with-other-systems">Use with other systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">First Steps with Sphinx</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#setting-up-the-documentation-sources">Setting up the documentation sources</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#defining-document-structure">Defining document structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#adding-content">Adding content</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#running-the-build">Running the build</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#documenting-objects">Documenting objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#basic-configuration">Basic configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#autodoc">Autodoc</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#more-topics-to-be-covered">More topics to be covered</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="invocation.html">Invocation of sphinx-build</a><ul>
<li class="toctree-l2"><a class="reference internal" href="invocation.html#makefile-options">Makefile options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="invocation.html#invocation-of-sphinx-apidoc">Invocation of sphinx-apidoc</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest.html">reStructuredText Primer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rest.html#paragraphs">Paragraphs</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#inline-markup">Inline markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#lists-and-quote-like-blocks">Lists and Quote-like blocks</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#source-code">Source Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#tables">Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#hyperlinks">Hyperlinks</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#sections">Sections</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#explicit-markup">Explicit Markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#directives">Directives</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#images">Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#footnotes">Footnotes</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#citations">Citations</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#substitutions">Substitutions</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#comments">Comments</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#source-encoding">Source encoding</a></li>
<li class="toctree-l2"><a class="reference internal" href="rest.html#gotchas">Gotchas</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="markup/index.html">Sphinx Markup Constructs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="markup/toctree.html">The TOC tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/para.html">Paragraph-level markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/para.html#table-of-contents-markup">Table-of-contents markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/para.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/para.html#grammar-production-displays">Grammar production displays</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/code.html">Showing code examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/inline.html">Inline markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="markup/misc.html">Miscellaneous markup</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="domains.html">Sphinx Domains</a><ul>
<li class="toctree-l2"><a class="reference internal" href="domains.html#what-is-a-domain">What is a Domain?</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#basic-markup">Basic Markup</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#the-python-domain">The Python Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#the-c-domain">The C Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#id1">The C++ Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#the-standard-domain">The Standard Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#the-javascript-domain">The JavaScript Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#the-restructuredtext-domain">The reStructuredText domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="domains.html#more-domains">More domains</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="builders.html">Available builders</a><ul>
<li class="toctree-l2"><a class="reference internal" href="builders.html#serialization-builder-details">Serialization builder details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="config.html">The build configuration file</a><ul>
<li class="toctree-l2"><a class="reference internal" href="config.html#general-configuration">General configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#project-information">Project information</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-internationalization">Options for internationalization</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-html-output">Options for HTML output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-epub-output">Options for epub output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-latex-output">Options for LaTeX output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-text-output">Options for text output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-manual-page-output">Options for manual page output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-texinfo-output">Options for Texinfo output</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#options-for-the-linkcheck-builder">Options for the linkcheck builder</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="intl.html">Internationalization</a></li>
<li class="toctree-l1"><a class="reference internal" href="theming.html">HTML theming support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="theming.html#using-a-theme">Using a theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="theming.html#builtin-themes">Builtin themes</a></li>
<li class="toctree-l2"><a class="reference internal" href="theming.html#creating-themes">Creating themes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="templating.html">Templating</a><ul>
<li class="toctree-l2"><a class="reference internal" href="templating.html#do-i-need-to-use-sphinx-templates-to-produce-html">Do I need to use Sphinx’ templates to produce HTML?</a></li>
<li class="toctree-l2"><a class="reference internal" href="templating.html#jinja-sphinx-templating-primer">Jinja/Sphinx Templating Primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="templating.html#working-with-the-builtin-templates">Working with the builtin templates</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="extensions.html">Sphinx Extensions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ext/tutorial.html">Tutorial: Writing a simple extension</a></li>
<li class="toctree-l2"><a class="reference internal" href="ext/appapi.html">Extension API</a></li>
<li class="toctree-l2"><a class="reference internal" href="ext/builderapi.html">Writing new builders</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html#builtin-sphinx-extensions">Builtin Sphinx extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html#third-party-extensions">Third-party extensions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="websupport.html">Sphinx Web Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="web/quickstart.html">Web Support Quick Start</a></li>
<li class="toctree-l2"><a class="reference internal" href="web/api.html">The WebSupport Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="web/searchadapters.html">Search Adapters</a></li>
<li class="toctree-l2"><a class="reference internal" href="web/storagebackends.html">Storage Backends</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Sphinx FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i">How do I...</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#using-sphinx-with">Using Sphinx with...</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#epub-info">Epub info</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#texinfo-info">Texinfo info</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changes in Sphinx</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-1-3-mar-10-2012">Release 1.1.3 (Mar 10, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-1-2-nov-1-2011-1-1-1-is-a-silly-version-number-anyway">Release 1.1.2 (Nov 1, 2011) – 1.1.1 is a silly version number anyway!</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-1-1-nov-1-2011">Release 1.1.1 (Nov 1, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-1-oct-9-2011">Release 1.1 (Oct 9, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-8-sep-23-2011">Release 1.0.8 (Sep 23, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-7-jan-15-2011">Release 1.0.7 (Jan 15, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-6-jan-04-2011">Release 1.0.6 (Jan 04, 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-5-nov-12-2010">Release 1.0.5 (Nov 12, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-4-sep-17-2010">Release 1.0.4 (Sep 17, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-3-aug-23-2010">Release 1.0.3 (Aug 23, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-2-aug-14-2010">Release 1.0.2 (Aug 14, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-1-jul-27-2010">Release 1.0.1 (Jul 27, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-jul-23-2010">Release 1.0 (Jul 23, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-7-jun-05-2010">Release 0.6.7 (Jun 05, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-6-may-25-2010">Release 0.6.6 (May 25, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-5-mar-01-2010">Release 0.6.5 (Mar 01, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-4-jan-12-2010">Release 0.6.4 (Jan 12, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-3-sep-03-2009">Release 0.6.3 (Sep 03, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-2-jun-16-2009">Release 0.6.2 (Jun 16, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-1-mar-26-2009">Release 0.6.1 (Mar 26, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-6-mar-24-2009">Release 0.6 (Mar 24, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-5-2-mar-24-2009">Release 0.5.2 (Mar 24, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-5-1-dec-15-2008">Release 0.5.1 (Dec 15, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-5-nov-23-2008-birthday-release">Release 0.5 (Nov 23, 2008) – Birthday release!</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-4-3-oct-8-2008">Release 0.4.3 (Oct 8, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-4-2-jul-29-2008">Release 0.4.2 (Jul 29, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-4-1-jul-5-2008">Release 0.4.1 (Jul 5, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-4-jun-23-2008">Release 0.4 (Jun 23, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-3-may-6-2008">Release 0.3 (May 6, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-2-apr-27-2008">Release 0.2 (Apr 27, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-1-61950-mar-26-2008">Release 0.1.61950 (Mar 26, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-1-61945-mar-26-2008">Release 0.1.61945 (Mar 26, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-1-61843-mar-24-2008">Release 0.1.61843 (Mar 24, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-1-61798-mar-23-2008">Release 0.1.61798 (Mar 23, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-0-1-61611-mar-21-2008">Release 0.1.61611 (Mar 21, 2008)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Projects using Sphinx</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-default-theme">Documentation using the default theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-a-customized-version-of-the-default-theme">Documentation using a customized version of the default theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-the-sphinxdoc-theme">Documentation using the sphinxdoc theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-another-builtin-theme">Documentation using another builtin theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#documentation-using-a-custom-theme-integrated-in-a-site">Documentation using a custom theme/integrated in a site</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#homepages-and-other-non-documentation-sites">Homepages and other non-documentation sites</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#books-produced-using-sphinx">Books produced using Sphinx</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
<li><a class="reference internal" href="glossary.html#glossary"><em>Glossary</em></a></li>
</ul>
</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="intro.html" title="Introduction"
>next</a> |</li>
<li><a href="index.html">Sphinx home</a> | </li>
<li><a href="#">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
>
94
