Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 2b39e69e45f9a0b2b3aece7339c56216 > files > 98

python-sphinx-doc-1.0.7-1.fc14.noarch.rpm



<!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>Index &mdash; 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" />
 
<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="#" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">Sphinx home</a>&nbsp;|&nbsp;</li>
        <li><a href="contents.html">Documentation</a>
          &raquo;</li>
 
      </ul>
    </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">

   

<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">
            

   <h1 id="index">Index</h1>

   <div class="genindex-jumpbox">
   <a href="#Symbols"><strong>Symbols</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#J"><strong>J</strong></a> | <a href="#K"><strong>K</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#Q"><strong>Q</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a> 
   </div>
<h2 id="Symbols">Symbols</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#_S_.getJSON">$.getJSON() ($ method)</a></dt>
    <dt>-a</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-a">command line option</a></dt>
  </dl></dd>
    <dt>-A name=value</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-A">command line option</a></dt>
  </dl></dd>
    <dt>-b buildername</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-b">command line option</a></dt>
  </dl></dd>
    <dt>-C</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-C">command line option</a></dt>
  </dl></dd>
    <dt>-c path</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-c">command line option</a></dt>
  </dl></dd>
    <dt>-d path</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-d">command line option</a></dt>
  </dl></dd>
    <dt>-D setting=value</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-D">command line option</a></dt>
  </dl></dd>
    <dt>-E</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-E">command line option</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>-N</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-N">command line option</a></dt>
  </dl></dd>
    <dt>-n</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-n">command line option</a></dt>
  </dl></dd>
    <dt>-P</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-P">command line option</a></dt>
  </dl></dd>
    <dt>-Q</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-Q">command line option</a></dt>
  </dl></dd>
    <dt>-q</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-q">command line option</a></dt>
  </dl></dd>
    <dt>-t tag</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-t">command line option</a></dt>
  </dl></dd>
    <dt>-W</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-W">command line option</a></dt>
  </dl></dd>
    <dt>-w file</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-w">command line option</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-abbr">abbr (role)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_autodoc_attrgetter">add_autodoc_attrgetter() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_autodocumenter">add_autodocumenter() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_builder">add_builder() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_config_value">add_config_value() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_crossref_type">add_crossref_type() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_directive">add_directive() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_directive_to_domain">add_directive_to_domain() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_domain">add_domain() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_event">add_event() (sphinx.application.Sphinx method)</a></dt>
    <dt>add_function_parentheses</dt>
    <dd><dl>
      <dt><a href="config.html#confval-add_function_parentheses">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_generic_role">add_generic_role() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_index_to_domain">add_index_to_domain() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_javascript">add_javascript() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_lexer">add_lexer() (sphinx.application.Sphinx method)</a></dt>
    <dt>add_module_names</dt>
    <dd><dl>
      <dt><a href="config.html#confval-add_module_names">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_node">add_node() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_object_type">add_object_type() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_role">add_role() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_role_to_domain">add_role_to_domain() (sphinx.application.Sphinx method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_stylesheet">add_stylesheet() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.add_transform">add_transform() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="domains.html#array:T:::subscript-operatorC">array&lt;T&gt;::operator[] (C++ function)</a></dt>
    <dt><a href="ext/autosummary.html#attributes">attributes (built-in variable)</a></dt>
    <dt><a href="ext/autodoc.html#directive-autoattribute">autoattribute (directive)</a></dt>
    <dt><a href="ext/autodoc.html#directive-autoclass">autoclass (directive)</a></dt>
    <dt>autoclass_content</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#confval-autoclass_content">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/autodoc.html#directive-autodata">autodata (directive)</a></dt>
    <dt>autodoc-process-docstring</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#event-autodoc-process-docstring">event</a></dt>
  </dl></dd>
    <dt>autodoc-process-signature</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#event-autodoc-process-signature">event</a></dt>
  </dl></dd>
    <dt>autodoc-skip-member</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#event-autodoc-skip-member">event</a></dt>
  </dl></dd>
    <dt>autodoc_default_flags</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#confval-autodoc_default_flags">configuration value</a></dt>
  </dl></dd>
    <dt>autodoc_member_order</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#confval-autodoc_member_order">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/autodoc.html#directive-autoexception">autoexception (directive)</a></dt>
    <dt><a href="ext/autodoc.html#directive-autofunction">autofunction (directive)</a></dt>
    <dt>automatic</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#index-0">documentation</a></dt>
      <dt><a href="ext/intersphinx.html#index-0">linking</a></dt>
      <dt><a href="ext/doctest.html#index-0">testing</a></dt>
  </dl></dd>
    <dt><a href="ext/autodoc.html#directive-automethod">automethod (directive)</a></dt>
    <dt><a href="ext/autodoc.html#directive-automodule">automodule (directive)</a></dt>
    <dt><a href="ext/autosummary.html#directive-autosummary">autosummary (directive)</a></dt>
    <dt>autosummary_generate</dt>
    <dd><dl>
      <dt><a href="ext/autosummary.html#confval-autosummary_generate">configuration value</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#directive-bar">bar (directive)</a></dt>
    <dt><a href="ext/autodoc.html#sphinx.ext.autodoc.between">between() (in module sphinx.ext.autodoc)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.build">build() (sphinx.builders.Builder method)</a></dt>
    <dt>build-finished</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-build-finished">event</a></dt>
  </dl></dd>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.build_all">build_all() (sphinx.builders.Builder method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.build_specific">build_specific() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.build_update">build_update() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="glossary.html#term-builder">builder</a></dt>
    <dd><dl>
      <dt><a href="templating.html#builder">(built-in variable)</a></dt>
  </dl></dd>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder">Builder (class in sphinx.builders)</a></dt>
    <dt>builder-inited</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-builder-inited">event</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#role-c:data">c:data (role)</a></dt>
    <dt><a href="domains.html#role-c:func">c:func (role)</a></dt>
    <dt><a href="domains.html#directive-c:function">c:function (directive)</a></dt>
    <dt><a href="domains.html#directive-c:macro">c:macro (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-c:macro">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-c:member">c:member (directive)</a></dt>
    <dt><a href="domains.html#directive-c:type">c:type (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-c:type">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-c:var">c:var (directive)</a></dt>
    <dt><a href="markup/para.html#directive-centered">centered (directive)</a></dt>
    <dt>changes</dt>
    <dd><dl>
      <dt><a href="markup/para.html#index-0">in version</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.changes.ChangesBuilder">ChangesBuilder (class in sphinx.builders.changes)</a></dt>
    <dt><a href="builders.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder">CheckExternalLinksBuilder (class in sphinx.builders.linkcheck)</a></dt>
    <dt><a href="ext/autosummary.html#class">class (built-in variable)</a></dt>
    <dt><a href="ext/autosummary.html#classes">classes (built-in variable)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.clear_doc">clear_doc() (sphinx.domains.Domain method)</a></dt>
    <dt>code</dt>
    <dd><dl>
      <dt><a href="markup/code.html#index-0">examples</a></dt>
  </dl></dd>
    <dt><a href="markup/misc.html#directive-codeauthor">codeauthor (directive)</a></dt>
    <dt><a href="markup/inline.html#role-command">command (role)</a></dt>
    <dt>command line option</dt>
    <dd><dl>
      <dt><a href="invocation.html#cmdoption-A">-A name=value</a></dt>
      <dt><a href="invocation.html#cmdoption-C">-C</a></dt>
      <dt><a href="invocation.html#cmdoption-D">-D setting=value</a></dt>
      <dt><a href="invocation.html#cmdoption-E">-E</a></dt>
      <dt><a href="invocation.html#cmdoption-N">-N</a></dt>
      <dt><a href="invocation.html#cmdoption-P">-P</a></dt>
      <dt><a href="invocation.html#cmdoption-Q">-Q</a></dt>
      <dt><a href="invocation.html#cmdoption-W">-W</a></dt>
      <dt><a href="invocation.html#cmdoption-a">-a</a></dt>
      <dt><a href="invocation.html#cmdoption-b">-b buildername</a></dt>
      <dt><a href="invocation.html#cmdoption-c">-c path</a></dt>
      <dt><a href="invocation.html#cmdoption-d">-d path</a></dt>
      <dt><a href="invocation.html#cmdoption-n">-n</a></dt>
      <dt><a href="invocation.html#cmdoption-q">-q</a></dt>
      <dt><a href="invocation.html#cmdoption-t">-t tag</a></dt>
      <dt><a href="invocation.html#cmdoption-w">-w file</a></dt>
  </dl></dd>
    <dt><a href="config.html#module-conf">conf (module)</a></dt>
    <dt><a href="glossary.html#term-configuration-directory">configuration directory</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>configuration value</dt>
    <dd><dl>
      <dt><a href="config.html#confval-add_function_parentheses">add_function_parentheses</a></dt>
      <dt><a href="config.html#confval-add_module_names">add_module_names</a></dt>
      <dt><a href="ext/autodoc.html#confval-autoclass_content">autoclass_content</a></dt>
      <dt><a href="ext/autodoc.html#confval-autodoc_default_flags">autodoc_default_flags</a></dt>
      <dt><a href="ext/autodoc.html#confval-autodoc_member_order">autodoc_member_order</a></dt>
      <dt><a href="ext/autosummary.html#confval-autosummary_generate">autosummary_generate</a></dt>
      <dt><a href="config.html#confval-copyright">copyright</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_c_path">coverage_c_path</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_c_regexes">coverage_c_regexes</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_c_items">coverage_ignore_c_items</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_classes">coverage_ignore_classes</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_functions">coverage_ignore_functions</a></dt>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_modules">coverage_ignore_modules</a></dt>
      <dt><a href="config.html#confval-default_role">default_role</a></dt>
      <dt><a href="ext/doctest.html#confval-doctest_global_setup">doctest_global_setup</a></dt>
      <dt><a href="ext/doctest.html#confval-doctest_path">doctest_path</a></dt>
      <dt><a href="ext/doctest.html#confval-doctest_test_doctest_blocks">doctest_test_doctest_blocks</a></dt>
      <dt><a href="config.html#confval-epub_author">epub_author</a></dt>
      <dt><a href="config.html#confval-epub_basename">epub_basename</a></dt>
      <dt><a href="config.html#confval-epub_copyright">epub_copyright</a></dt>
      <dt><a href="config.html#confval-epub_exclude_files">epub_exclude_files</a></dt>
      <dt><a href="config.html#confval-epub_identifier">epub_identifier</a></dt>
      <dt><a href="config.html#confval-epub_language">epub_language</a></dt>
      <dt><a href="config.html#confval-epub_post_files">epub_post_files</a></dt>
      <dt><a href="config.html#confval-epub_pre_files">epub_pre_files</a></dt>
      <dt><a href="config.html#confval-epub_publisher">epub_publisher</a></dt>
      <dt><a href="config.html#confval-epub_scheme">epub_scheme</a></dt>
      <dt><a href="config.html#confval-epub_theme">epub_theme</a></dt>
      <dt><a href="config.html#confval-epub_title">epub_title</a></dt>
      <dt><a href="config.html#confval-epub_tocdepth">epub_tocdepth</a></dt>
      <dt><a href="config.html#confval-epub_tocdup">epub_tocdup</a></dt>
      <dt><a href="config.html#confval-epub_uid">epub_uid</a></dt>
      <dt><a href="config.html#confval-exclude_dirnames">exclude_dirnames</a></dt>
      <dt><a href="config.html#confval-exclude_patterns">exclude_patterns</a></dt>
      <dt><a href="config.html#confval-exclude_trees">exclude_trees</a></dt>
      <dt><a href="config.html#confval-extensions">extensions</a></dt>
      <dt><a href="ext/extlinks.html#confval-extlinks">extlinks</a></dt>
      <dt><a href="ext/graphviz.html#confval-graphviz_dot">graphviz_dot</a></dt>
      <dt><a href="ext/graphviz.html#confval-graphviz_dot_args">graphviz_dot_args</a></dt>
      <dt><a href="ext/graphviz.html#confval-graphviz_output_format">graphviz_output_format</a></dt>
      <dt><a href="config.html#confval-highlight_language">highlight_language</a></dt>
      <dt><a href="config.html#confval-html_add_permalinks">html_add_permalinks</a></dt>
      <dt><a href="config.html#confval-html_additional_pages">html_additional_pages</a></dt>
      <dt><a href="config.html#confval-html_compact_lists">html_compact_lists</a></dt>
      <dt><a href="config.html#confval-html_context">html_context</a></dt>
      <dt><a href="config.html#confval-html_copy_source">html_copy_source</a></dt>
      <dt><a href="config.html#confval-html_domain_indices">html_domain_indices</a></dt>
      <dt><a href="config.html#confval-html_favicon">html_favicon</a></dt>
      <dt><a href="config.html#confval-html_file_suffix">html_file_suffix</a></dt>
      <dt><a href="config.html#confval-html_last_updated_fmt">html_last_updated_fmt</a></dt>
      <dt><a href="config.html#confval-html_link_suffix">html_link_suffix</a></dt>
      <dt><a href="config.html#confval-html_logo">html_logo</a></dt>
      <dt><a href="config.html#confval-html_output_encoding">html_output_encoding</a></dt>
      <dt><a href="config.html#confval-html_secnumber_suffix">html_secnumber_suffix</a></dt>
      <dt><a href="config.html#confval-html_short_title">html_short_title</a></dt>
      <dt><a href="config.html#confval-html_show_copyright">html_show_copyright</a></dt>
      <dt><a href="config.html#confval-html_show_sourcelink">html_show_sourcelink</a></dt>
      <dt><a href="config.html#confval-html_show_sphinx">html_show_sphinx</a></dt>
      <dt><a href="config.html#confval-html_sidebars">html_sidebars</a></dt>
      <dt><a href="config.html#confval-html_split_index">html_split_index</a></dt>
      <dt><a href="config.html#confval-html_static_path">html_static_path</a></dt>
      <dt><a href="config.html#confval-html_style">html_style</a></dt>
      <dt><a href="config.html#confval-html_theme">html_theme</a></dt>
      <dt><a href="config.html#confval-html_theme_options">html_theme_options</a></dt>
      <dt><a href="config.html#confval-html_theme_path">html_theme_path</a></dt>
      <dt><a href="config.html#confval-html_title">html_title</a></dt>
      <dt><a href="config.html#confval-html_translator_class">html_translator_class</a></dt>
      <dt><a href="config.html#confval-html_use_index">html_use_index</a></dt>
      <dt><a href="config.html#confval-html_use_modindex">html_use_modindex</a></dt>
      <dt><a href="config.html#confval-html_use_opensearch">html_use_opensearch</a></dt>
      <dt><a href="config.html#confval-html_use_smartypants">html_use_smartypants</a></dt>
      <dt><a href="config.html#confval-htmlhelp_basename">htmlhelp_basename</a></dt>
      <dt><a href="ext/inheritance.html#confval-inheritance_edge_attrs">inheritance_edge_attrs</a></dt>
      <dt><a href="ext/inheritance.html#confval-inheritance_graph_attrs">inheritance_graph_attrs</a></dt>
      <dt><a href="ext/inheritance.html#confval-inheritance_node_attrs">inheritance_node_attrs</a></dt>
      <dt><a href="ext/intersphinx.html#confval-intersphinx_cache_limit">intersphinx_cache_limit</a></dt>
      <dt><a href="ext/intersphinx.html#confval-intersphinx_mapping">intersphinx_mapping</a></dt>
      <dt><a href="ext/math.html#confval-jsmath_path">jsmath_path</a></dt>
      <dt><a href="config.html#confval-keep_warnings">keep_warnings</a></dt>
      <dt><a href="config.html#confval-language">language</a></dt>
      <dt><a href="config.html#confval-latex_additional_files">latex_additional_files</a></dt>
      <dt><a href="config.html#confval-latex_appendices">latex_appendices</a></dt>
      <dt><a href="config.html#confval-latex_docclass">latex_docclass</a></dt>
      <dt><a href="config.html#confval-latex_documents">latex_documents</a></dt>
      <dt><a href="config.html#confval-latex_domain_indices">latex_domain_indices</a></dt>
      <dt><a href="config.html#confval-latex_elements">latex_elements</a></dt>
      <dt><a href="config.html#confval-latex_font_size">latex_font_size</a></dt>
      <dt><a href="config.html#confval-latex_logo">latex_logo</a></dt>
      <dt><a href="config.html#confval-latex_paper_size">latex_paper_size</a></dt>
      <dt><a href="config.html#confval-latex_preamble">latex_preamble</a></dt>
      <dt><a href="config.html#confval-latex_show_pagerefs">latex_show_pagerefs</a></dt>
      <dt><a href="config.html#confval-latex_show_urls">latex_show_urls</a></dt>
      <dt><a href="config.html#confval-latex_use_modindex">latex_use_modindex</a></dt>
      <dt><a href="config.html#confval-latex_use_parts">latex_use_parts</a></dt>
      <dt><a href="config.html#confval-locale_dirs">locale_dirs</a></dt>
      <dt><a href="config.html#confval-man_pages">man_pages</a></dt>
      <dt><a href="config.html#confval-master_doc">master_doc</a></dt>
      <dt><a href="config.html#confval-modindex_common_prefix">modindex_common_prefix</a></dt>
      <dt><a href="config.html#confval-needs_sphinx">needs_sphinx</a></dt>
      <dt><a href="config.html#confval-nitpicky">nitpicky</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_dvipng">pngmath_dvipng</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_dvipng_args">pngmath_dvipng_args</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_latex">pngmath_latex</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_latex_args">pngmath_latex_args</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_latex_preamble">pngmath_latex_preamble</a></dt>
      <dt><a href="ext/math.html#confval-pngmath_use_preview">pngmath_use_preview</a></dt>
      <dt><a href="config.html#confval-primary_domain">primary_domain</a></dt>
      <dt><a href="config.html#confval-project">project</a></dt>
      <dt><a href="config.html#confval-pygments_style">pygments_style</a></dt>
      <dt><a href="config.html#confval-release">release</a></dt>
      <dt><a href="config.html#confval-rst_epilog">rst_epilog</a></dt>
      <dt><a href="config.html#confval-rst_prolog">rst_prolog</a></dt>
      <dt><a href="config.html#confval-show_authors">show_authors</a></dt>
      <dt><a href="config.html#confval-source_encoding">source_encoding</a></dt>
      <dt><a href="config.html#confval-source_suffix">source_suffix</a></dt>
      <dt><a href="config.html#confval-template_bridge">template_bridge</a></dt>
      <dt><a href="config.html#confval-templates_path">templates_path</a></dt>
      <dt><a href="config.html#confval-today">today</a></dt>
      <dt><a href="config.html#confval-today_fmt">today_fmt</a></dt>
      <dt><a href="ext/todo.html#confval-todo_include_todos">todo_include_todos</a></dt>
      <dt><a href="config.html#confval-trim_doctest_flags">trim_doctest_flags</a></dt>
      <dt><a href="config.html#confval-trim_footnote_reference_space">trim_footnote_reference_space</a></dt>
      <dt><a href="config.html#confval-unused_docs">unused_docs</a></dt>
      <dt><a href="config.html#confval-version">version</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.connect">connect() (sphinx.application.Sphinx method)</a></dt>
    <dt>contents</dt>
    <dd><dl>
      <dt><a href="markup/toctree.html#index-0">table of</a></dt>
  </dl></dd>
    <dt>copyright</dt>
    <dd><dl>
      <dt><a href="config.html#confval-copyright">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#copyright">copyright (built-in variable)</a></dt>
    <dt>coverage_c_path</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_c_path">configuration value</a></dt>
  </dl></dd>
    <dt>coverage_c_regexes</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_c_regexes">configuration value</a></dt>
  </dl></dd>
    <dt>coverage_ignore_c_items</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_c_items">configuration value</a></dt>
  </dl></dd>
    <dt>coverage_ignore_classes</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_classes">configuration value</a></dt>
  </dl></dd>
    <dt>coverage_ignore_functions</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_functions">configuration value</a></dt>
  </dl></dd>
    <dt>coverage_ignore_modules</dt>
    <dd><dl>
      <dt><a href="ext/coverage.html#confval-coverage_ignore_modules">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/coverage.html#sphinx.ext.coverage.CoverageBuilder">CoverageBuilder (class in sphinx.ext.coverage)</a></dt>
    <dt><a href="domains.html#directive-cpp:class">cpp:class (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-cpp:class">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#role-cpp:func">cpp:func (role)</a></dt>
    <dt><a href="domains.html#directive-cpp:function">cpp:function (directive)</a></dt>
    <dt><a href="domains.html#directive-cpp:member">cpp:member (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-cpp:member">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-cpp:namespace">cpp:namespace (directive)</a></dt>
    <dt><a href="domains.html#directive-cpp:type">cpp:type (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-cpp:type">(role)</a></dt>
  </dl></dd>
    <dt><a href="ext/autodoc.html#sphinx.ext.autodoc.cut_lines">cut_lines() (in module sphinx.ext.autodoc)</a></dt>
</dl></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.dangling_warnings">dangling_warnings (sphinx.domains.Domain attribute)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.data_version">data_version (sphinx.domains.Domain attribute)</a></dt>
    <dt>default</dt>
    <dd><dl>
      <dt><a href="config.html#index-1">domain</a></dt>
      <dt><a href="config.html#index-2">role</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-default-domain">default-domain (directive)</a></dt>
    <dt>default_role</dt>
    <dd><dl>
      <dt><a href="config.html#confval-default_role">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/para.html#directive-deprecated">deprecated (directive)</a></dt>
    <dt><a href="domains.html#directive-describe">describe (directive)</a></dt>
    <dt><a href="builders.html#sphinx.builders.devhelp.DevhelpBuilder">DevhelpBuilder (class in sphinx.builders.devhelp)</a></dt>
    <dt><a href="markup/inline.html#role-dfn">dfn (role)</a></dt>
    <dt><a href="ext/graphviz.html#directive-digraph">digraph (directive)</a></dt>
    <dt><a href="glossary.html#term-directive">directive</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.directive">directive() (sphinx.domains.Domain method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.directives">directives (sphinx.domains.Domain attribute)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.DirectoryHTMLBuilder">DirectoryHTMLBuilder (class in sphinx.builders.html)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.disconnect">disconnect() (sphinx.application.Sphinx method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-doc">doc (role)</a></dt>
    <dt><a href="templating.html#docstitle">docstitle (built-in variable)</a></dt>
    <dt><a href="ext/autodoc.html#index-0">docstring</a></dt>
    <dt><a href="ext/doctest.html#index-0">doctest</a></dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#directive-doctest">(directive)</a></dt>
  </dl></dd>
    <dt>doctest_global_setup</dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#confval-doctest_global_setup">configuration value</a></dt>
  </dl></dd>
    <dt>doctest_path</dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#confval-doctest_path">configuration value</a></dt>
  </dl></dd>
    <dt>doctest_test_doctest_blocks</dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#confval-doctest_test_doctest_blocks">configuration value</a></dt>
  </dl></dd>
    <dt>doctree-read</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-doctree-read">event</a></dt>
  </dl></dd>
    <dt>doctree-resolved</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-doctree-resolved">event</a></dt>
  </dl></dd>
    <dt><a href="glossary.html#term-document-name">document name</a></dt>
    <dt>documentation</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#index-0">automatic</a></dt>
  </dl></dd>
    <dt><a href="glossary.html#term-domain">domain</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain">Domain (class in sphinx.domains)</a></dt>
    <dt><a href="markup/inline.html#role-download">download (role)</a></dt>
</dl></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#embedded">embedded (built-in variable)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.emit">emit() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.emit_firstresult">emit_firstresult() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="tutorial.html#enumerate">enumerate() (built-in function)</a></dt>
    <dt>env-purge-doc</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-env-purge-doc">event</a></dt>
  </dl></dd>
    <dt>env-updated</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-env-updated">event</a></dt>
  </dl></dd>
    <dt><a href="glossary.html#term-environment">environment</a></dt>
    <dt><a href="domains.html#directive-envvar">envvar (directive)</a></dt>
    <dd><dl>
      <dt><a href="markup/inline.html#role-envvar">(role)</a></dt>
  </dl></dd>
    <dt>epub_author</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_author">configuration value</a></dt>
  </dl></dd>
    <dt>epub_basename</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_basename">configuration value</a></dt>
  </dl></dd>
    <dt>epub_copyright</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_copyright">configuration value</a></dt>
  </dl></dd>
    <dt>epub_exclude_files</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_exclude_files">configuration value</a></dt>
  </dl></dd>
    <dt>epub_identifier</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_identifier">configuration value</a></dt>
  </dl></dd>
    <dt>epub_language</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_language">configuration value</a></dt>
  </dl></dd>
    <dt>epub_post_files</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_post_files">configuration value</a></dt>
  </dl></dd>
    <dt>epub_pre_files</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_pre_files">configuration value</a></dt>
  </dl></dd>
    <dt>epub_publisher</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_publisher">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>epub_scheme</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_scheme">configuration value</a></dt>
  </dl></dd>
    <dt>epub_theme</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_theme">configuration value</a></dt>
  </dl></dd>
    <dt>epub_title</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_title">configuration value</a></dt>
  </dl></dd>
    <dt>epub_tocdepth</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_tocdepth">configuration value</a></dt>
  </dl></dd>
    <dt>epub_tocdup</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_tocdup">configuration value</a></dt>
  </dl></dd>
    <dt>epub_uid</dt>
    <dd><dl>
      <dt><a href="config.html#confval-epub_uid">configuration value</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.epub.EpubBuilder">EpubBuilder (class in sphinx.builders.epub)</a></dt>
    <dt><a href="ext/math.html#role-eq">eq (role)</a></dt>
    <dt>event</dt>
    <dd><dl>
      <dt><a href="ext/autodoc.html#event-autodoc-process-docstring">autodoc-process-docstring</a></dt>
      <dt><a href="ext/autodoc.html#event-autodoc-process-signature">autodoc-process-signature</a></dt>
      <dt><a href="ext/autodoc.html#event-autodoc-skip-member">autodoc-skip-member</a></dt>
      <dt><a href="ext/appapi.html#event-build-finished">build-finished</a></dt>
      <dt><a href="ext/appapi.html#event-builder-inited">builder-inited</a></dt>
      <dt><a href="ext/appapi.html#event-doctree-read">doctree-read</a></dt>
      <dt><a href="ext/appapi.html#event-doctree-resolved">doctree-resolved</a></dt>
      <dt><a href="ext/appapi.html#event-env-purge-doc">env-purge-doc</a></dt>
      <dt><a href="ext/appapi.html#event-env-updated">env-updated</a></dt>
      <dt><a href="ext/appapi.html#event-html-collect-pages">html-collect-pages</a></dt>
      <dt><a href="ext/appapi.html#event-html-page-context">html-page-context</a></dt>
      <dt><a href="ext/appapi.html#event-missing-reference">missing-reference</a></dt>
      <dt><a href="ext/appapi.html#event-source-read">source-read</a></dt>
  </dl></dd>
    <dt>examples</dt>
    <dd><dl>
      <dt><a href="markup/code.html#index-0">code</a></dt>
  </dl></dd>
    <dt><a href="ext/autosummary.html#exceptions">exceptions (built-in variable)</a></dt>
    <dt>exclude_dirnames</dt>
    <dd><dl>
      <dt><a href="config.html#confval-exclude_dirnames">configuration value</a></dt>
  </dl></dd>
    <dt>exclude_patterns</dt>
    <dd><dl>
      <dt><a href="config.html#confval-exclude_patterns">configuration value</a></dt>
  </dl></dd>
    <dt>exclude_trees</dt>
    <dd><dl>
      <dt><a href="config.html#confval-exclude_trees">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.ExtensionError">ExtensionError</a></dt>
    <dt>extensions</dt>
    <dd><dl>
      <dt><a href="config.html#confval-extensions">configuration value</a></dt>
  </dl></dd>
    <dt>extlinks</dt>
    <dd><dl>
      <dt><a href="ext/extlinks.html#confval-extlinks">configuration value</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#favicon">favicon (built-in variable)</a></dt>
    <dt><a href="markup/inline.html#role-file">file (role)</a></dt>
    <dt><a href="templating.html#file_suffix">file_suffix (built-in variable)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.finish">finish() (sphinx.builders.Builder method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#directive-foo">foo (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-foo">(role)</a></dt>
  </dl></dd>
    <dt><a href="ext/autosummary.html#fullname">fullname (built-in variable)</a></dt>
    <dt><a href="ext/autosummary.html#functions">functions (built-in variable)</a></dt>
</dl></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/appapi.html#sphinx.domains.Index.generate">generate() (sphinx.domains.Index method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.get_objects">get_objects() (sphinx.domains.Domain method)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.get_outdated_docs">get_outdated_docs() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.get_relative_uri">get_relative_uri() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.get_target_uri">get_target_uri() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.get_type_name">get_type_name() (sphinx.domains.Domain method)</a></dt>
    <dt>global</dt>
    <dd><dl>
      <dt><a href="config.html#index-0">substitutions</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.html.SerializingHTMLBuilder.globalcontext_filename">globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder attribute)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/para.html#directive-glossary">glossary (directive)</a></dt>
    <dt><a href="ext/graphviz.html#directive-graph">graph (directive)</a></dt>
    <dt><a href="ext/graphviz.html#directive-graphviz">graphviz (directive)</a></dt>
    <dt>graphviz_dot</dt>
    <dd><dl>
      <dt><a href="ext/graphviz.html#confval-graphviz_dot">configuration value</a></dt>
  </dl></dd>
    <dt>graphviz_dot_args</dt>
    <dd><dl>
      <dt><a href="ext/graphviz.html#confval-graphviz_dot_args">configuration value</a></dt>
  </dl></dd>
    <dt>graphviz_output_format</dt>
    <dd><dl>
      <dt><a href="ext/graphviz.html#confval-graphviz_output_format">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/inline.html#role-guilabel">guilabel (role)</a></dt>
</dl></td>
</tr></table>

<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#has_source">has_source (built-in variable)</a></dt>
    <dt><a href="templating.html#hasdoc">hasdoc() (built-in function)</a></dt>
    <dt>highlight_language</dt>
    <dd><dl>
      <dt><a href="config.html#confval-highlight_language">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/para.html#directive-hlist">hlist (directive)</a></dt>
    <dt>html-collect-pages</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-html-collect-pages">event</a></dt>
  </dl></dd>
    <dt>html-page-context</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-html-page-context">event</a></dt>
  </dl></dd>
    <dt>html_add_permalinks</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_add_permalinks">configuration value</a></dt>
  </dl></dd>
    <dt>html_additional_pages</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_additional_pages">configuration value</a></dt>
  </dl></dd>
    <dt>html_compact_lists</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_compact_lists">configuration value</a></dt>
  </dl></dd>
    <dt>html_context</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_context">configuration value</a></dt>
  </dl></dd>
    <dt>html_copy_source</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_copy_source">configuration value</a></dt>
  </dl></dd>
    <dt>html_domain_indices</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_domain_indices">configuration value</a></dt>
  </dl></dd>
    <dt>html_favicon</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_favicon">configuration value</a></dt>
  </dl></dd>
    <dt>html_file_suffix</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_file_suffix">configuration value</a></dt>
  </dl></dd>
    <dt>html_last_updated_fmt</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_last_updated_fmt">configuration value</a></dt>
  </dl></dd>
    <dt>html_link_suffix</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_link_suffix">configuration value</a></dt>
  </dl></dd>
    <dt>html_logo</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_logo">configuration value</a></dt>
  </dl></dd>
    <dt>html_output_encoding</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_output_encoding">configuration value</a></dt>
  </dl></dd>
    <dt>html_secnumber_suffix</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_secnumber_suffix">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>html_short_title</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_short_title">configuration value</a></dt>
  </dl></dd>
    <dt>html_show_copyright</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_show_copyright">configuration value</a></dt>
  </dl></dd>
    <dt>html_show_sourcelink</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_show_sourcelink">configuration value</a></dt>
  </dl></dd>
    <dt>html_show_sphinx</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_show_sphinx">configuration value</a></dt>
  </dl></dd>
    <dt>html_sidebars</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_sidebars">configuration value</a></dt>
  </dl></dd>
    <dt>html_split_index</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_split_index">configuration value</a></dt>
  </dl></dd>
    <dt>html_static_path</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_static_path">configuration value</a></dt>
  </dl></dd>
    <dt>html_style</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_style">configuration value</a></dt>
  </dl></dd>
    <dt>html_theme</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_theme">configuration value</a></dt>
  </dl></dd>
    <dt>html_theme_options</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_theme_options">configuration value</a></dt>
  </dl></dd>
    <dt>html_theme_path</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_theme_path">configuration value</a></dt>
  </dl></dd>
    <dt>html_title</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_title">configuration value</a></dt>
  </dl></dd>
    <dt>html_translator_class</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_translator_class">configuration value</a></dt>
  </dl></dd>
    <dt>html_use_index</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_use_index">configuration value</a></dt>
  </dl></dd>
    <dt>html_use_modindex</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_use_modindex">configuration value</a></dt>
  </dl></dd>
    <dt>html_use_opensearch</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_use_opensearch">configuration value</a></dt>
  </dl></dd>
    <dt>html_use_smartypants</dt>
    <dd><dl>
      <dt><a href="config.html#confval-html_use_smartypants">configuration value</a></dt>
  </dl></dd>
    <dt>htmlhelp_basename</dt>
    <dd><dl>
      <dt><a href="config.html#confval-htmlhelp_basename">configuration value</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.htmlhelp.HTMLHelpBuilder">HTMLHelpBuilder (class in sphinx.builders.htmlhelp)</a></dt>
</dl></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/ifconfig.html#directive-ifconfig">ifconfig (directive)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.SerializingHTMLBuilder.implementation">implementation (sphinx.builders.html.SerializingHTMLBuilder attribute)</a></dt>
    <dt>in version</dt>
    <dd><dl>
      <dt><a href="markup/para.html#index-0">changes</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.domains.Index">Index (class in sphinx.domains)</a></dt>
    <dt><a href="markup/para.html#directive-index">index (directive)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.indices">indices (sphinx.domains.Domain attribute)</a></dt>
    <dt><a href="ext/inheritance.html#directive-inheritance-diagram">inheritance-diagram (directive)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>inheritance_edge_attrs</dt>
    <dd><dl>
      <dt><a href="ext/inheritance.html#confval-inheritance_edge_attrs">configuration value</a></dt>
  </dl></dd>
    <dt>inheritance_graph_attrs</dt>
    <dd><dl>
      <dt><a href="ext/inheritance.html#confval-inheritance_graph_attrs">configuration value</a></dt>
  </dl></dd>
    <dt>inheritance_node_attrs</dt>
    <dd><dl>
      <dt><a href="ext/inheritance.html#confval-inheritance_node_attrs">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.TemplateBridge.init">init() (sphinx.application.TemplateBridge method)</a></dt>
    <dd><dl>
      <dt><a href="ext/builderapi.html#sphinx.builders.Builder.init">(sphinx.builders.Builder method)</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.initial_data">initial_data (sphinx.domains.Domain attribute)</a></dt>
    <dt>intersphinx_cache_limit</dt>
    <dd><dl>
      <dt><a href="ext/intersphinx.html#confval-intersphinx_cache_limit">configuration value</a></dt>
  </dl></dd>
    <dt>intersphinx_mapping</dt>
    <dd><dl>
      <dt><a href="ext/intersphinx.html#confval-intersphinx_mapping">configuration value</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="J">J</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#role-js:attr">js:attr (role)</a></dt>
    <dt><a href="domains.html#directive-js:attribute">js:attribute (directive)</a></dt>
    <dt><a href="domains.html#directive-js:class">js:class (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-js:class">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-js:data">js:data (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-js:data">(role)</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#role-js:func">js:func (role)</a></dt>
    <dt><a href="domains.html#directive-js:function">js:function (directive)</a></dt>
    <dt>jsmath_path</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-jsmath_path">configuration value</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.html.JSONHTMLBuilder">JSONHTMLBuilder (class in sphinx.builders.html)</a></dt>
</dl></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-kbd">kbd (role)</a></dt>
    <dt>keep_warnings</dt>
    <dd><dl>
      <dt><a href="config.html#confval-keep_warnings">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-keyword">keyword (role)</a></dt>
</dl></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.label">label (sphinx.domains.Domain attribute)</a></dt>
    <dt>language</dt>
    <dd><dl>
      <dt><a href="config.html#confval-language">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#last_updated">last_updated (built-in variable)</a></dt>
    <dt>latex_additional_files</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_additional_files">configuration value</a></dt>
  </dl></dd>
    <dt>latex_appendices</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_appendices">configuration value</a></dt>
  </dl></dd>
    <dt>latex_docclass</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_docclass">configuration value</a></dt>
  </dl></dd>
    <dt>latex_documents</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_documents">configuration value</a></dt>
  </dl></dd>
    <dt>latex_domain_indices</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_domain_indices">configuration value</a></dt>
  </dl></dd>
    <dt>latex_elements</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_elements">configuration value</a></dt>
  </dl></dd>
    <dt>latex_font_size</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_font_size">configuration value</a></dt>
  </dl></dd>
    <dt>latex_logo</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_logo">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt>latex_paper_size</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_paper_size">configuration value</a></dt>
  </dl></dd>
    <dt>latex_preamble</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_preamble">configuration value</a></dt>
  </dl></dd>
    <dt>latex_show_pagerefs</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_show_pagerefs">configuration value</a></dt>
  </dl></dd>
    <dt>latex_show_urls</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_show_urls">configuration value</a></dt>
  </dl></dd>
    <dt>latex_use_modindex</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_use_modindex">configuration value</a></dt>
  </dl></dd>
    <dt>latex_use_parts</dt>
    <dd><dl>
      <dt><a href="config.html#confval-latex_use_parts">configuration value</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.latex.LaTeXBuilder">LaTeXBuilder (class in sphinx.builders.latex)</a></dt>
    <dt>linking</dt>
    <dd><dl>
      <dt><a href="ext/intersphinx.html#index-0">automatic</a></dt>
  </dl></dd>
    <dt><a href="markup/code.html#directive-literalinclude">literalinclude (directive)</a></dt>
    <dt>locale_dirs</dt>
    <dd><dl>
      <dt><a href="config.html#confval-locale_dirs">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#logo">logo (built-in variable)</a></dt>
</dl></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-mailheader">mailheader (role)</a></dt>
    <dt><a href="markup/inline.html#role-makevar">makevar (role)</a></dt>
    <dt>man_pages</dt>
    <dd><dl>
      <dt><a href="config.html#confval-man_pages">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/inline.html#role-manpage">manpage (role)</a></dt>
    <dt><a href="builders.html#sphinx.builders.manpage.ManualPageBuilder">ManualPageBuilder (class in sphinx.builders.manpage)</a></dt>
    <dt><a href="glossary.html#term-master-document">master document</a></dt>
    <dt>master_doc</dt>
    <dd><dl>
      <dt><a href="config.html#confval-master_doc">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#master_doc">master_doc (built-in variable)</a></dt>
    <dt><a href="ext/math.html#directive-math">math (directive)</a></dt>
    <dd><dl>
      <dt><a href="ext/math.html#role-math">(role)</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/autosummary.html#members">members (built-in variable)</a></dt>
    <dt><a href="markup/inline.html#role-menuselection">menuselection (role)</a></dt>
    <dt><a href="templating.html#meta">meta (built-in variable)</a></dt>
    <dt><a href="ext/autosummary.html#methods">methods (built-in variable)</a></dt>
    <dt><a href="markup/inline.html#role-mimetype">mimetype (role)</a></dt>
    <dt>missing-reference</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-missing-reference">event</a></dt>
  </dl></dd>
    <dt>modindex_common_prefix</dt>
    <dd><dl>
      <dt><a href="config.html#confval-modindex_common_prefix">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/autosummary.html#module">module (built-in variable)</a></dt>
    <dt><a href="domains.html#MyAnimal">MyAnimal() (class)</a></dt>
</dl></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/autosummary.html#name">name (built-in variable)</a></dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#sphinx.domains.Domain.name">(sphinx.domains.Domain attribute)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#namespaced::theclass::method__i.ss">namespaced::theclass::method (C++ function)</a>, <a href="domains.html#namespaced::theclass::method__arg1.arg2">[1]</a></dt>
    <dt>needs_sphinx</dt>
    <dd><dl>
      <dt><a href="config.html#confval-needs_sphinx">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.TemplateBridge.newest_template_mtime">newest_template_mtime() (sphinx.application.TemplateBridge method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-newsgroup">newsgroup (role)</a></dt>
    <dt><a href="templating.html#next">next (built-in variable)</a></dt>
    <dt>nitpicky</dt>
    <dd><dl>
      <dt><a href="config.html#confval-nitpicky">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/para.html#index-0">note</a></dt>
    <dd><dl>
      <dt><a href="markup/para.html#directive-note">(directive)</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="glossary.html#term-object">object</a></dt>
    <dd><dl>
      <dt><a href="domains.html#directive-object">(directive)</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.object_types">object_types (sphinx.domains.Domain attribute)</a></dt>
    <dt><a href="ext/autosummary.html#objname">objname (built-in variable)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.ObjType">ObjType (class in sphinx.domains)</a></dt>
    <dt><a href="markup/misc.html#directive-only">only (directive)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#castto-b-operatorC">operator bool (C++ function)</a></dt>
    <dt><a href="domains.html#directive-option">option (directive)</a></dt>
    <dd><dl>
      <dt><a href="markup/inline.html#role-option">(role)</a></dt>
  </dl></dd>
    <dt><a href="builders.html#sphinx.builders.html.SerializingHTMLBuilder.out_suffix">out_suffix (sphinx.builders.html.SerializingHTMLBuilder attribute)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.override_domain">override_domain() (sphinx.application.Sphinx method)</a></dt>
</dl></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#pagename">pagename (built-in variable)</a></dt>
    <dt><a href="templating.html#parents">parents (built-in variable)</a></dt>
    <dt><a href="templating.html#pathto">pathto() (built-in function)</a>, <a href="templating.html#pathto">[1]</a></dt>
    <dt><a href="markup/inline.html#role-pep">pep (role)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.PickleHTMLBuilder">PickleHTMLBuilder (class in sphinx.builders.html)</a></dt>
    <dt>pngmath_dvipng</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_dvipng">configuration value</a></dt>
  </dl></dd>
    <dt>pngmath_dvipng_args</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_dvipng_args">configuration value</a></dt>
  </dl></dd>
    <dt>pngmath_latex</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_latex">configuration value</a></dt>
  </dl></dd>
    <dt>pngmath_latex_args</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_latex_args">configuration value</a></dt>
  </dl></dd>
    <dt>pngmath_latex_preamble</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_latex_preamble">configuration value</a></dt>
  </dl></dd>
    <dt>pngmath_use_preview</dt>
    <dd><dl>
      <dt><a href="ext/math.html#confval-pngmath_use_preview">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.prepare_writing">prepare_writing() (sphinx.builders.Builder method)</a></dt>
    <dt><a href="templating.html#prev">prev (built-in variable)</a></dt>
    <dt>primary</dt>
    <dd><dl>
      <dt><a href="config.html#index-1">domain</a></dt>
  </dl></dd>
    <dt>primary_domain</dt>
    <dd><dl>
      <dt><a href="config.html#confval-primary_domain">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.process_doc">process_doc() (sphinx.domains.Domain method)</a></dt>
    <dt><a href="markup/para.html#directive-productionlist">productionlist (directive)</a></dt>
    <dt><a href="domains.html#directive-program">program (directive)</a></dt>
    <dd><dl>
      <dt><a href="markup/inline.html#role-program">(role)</a></dt>
  </dl></dd>
    <dt>project</dt>
    <dd><dl>
      <dt><a href="config.html#confval-project">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#project">project (built-in variable)</a></dt>
    <dt><a href="domains.html#role-py:attr">py:attr (role)</a></dt>
    <dt><a href="domains.html#directive-py:attribute">py:attribute (directive)</a></dt>
    <dt><a href="domains.html#directive-py:class">py:class (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-py:class">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#directive-py:classmethod">py:classmethod (directive)</a></dt>
    <dt><a href="domains.html#role-py:const">py:const (role)</a></dt>
    <dt><a href="domains.html#directive-py:currentmodule">py:currentmodule (directive)</a></dt>
    <dt><a href="domains.html#directive-py:data">py:data (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-py:data">(role)</a></dt>
  </dl></dd>
    <dt><a href="domains.html#role-py:exc">py:exc (role)</a></dt>
    <dt><a href="domains.html#directive-py:exception">py:exception (directive)</a></dt>
    <dt><a href="domains.html#role-py:func">py:func (role)</a></dt>
    <dt><a href="domains.html#directive-py:function">py:function (directive)</a></dt>
    <dt><a href="domains.html#role-py:meth">py:meth (role)</a></dt>
    <dt><a href="domains.html#directive-py:method">py:method (directive)</a></dt>
    <dt><a href="domains.html#role-py:mod">py:mod (role)</a></dt>
    <dt><a href="domains.html#directive-py:module">py:module (directive)</a></dt>
    <dt><a href="domains.html#role-py:obj">py:obj (role)</a></dt>
    <dt><a href="domains.html#directive-py:staticmethod">py:staticmethod (directive)</a></dt>
    <dt>pygments_style</dt>
    <dd><dl>
      <dt><a href="config.html#confval-pygments_style">configuration value</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="builders.html#sphinx.builders.qthelp.QtHelpBuilder">QtHelpBuilder (class in sphinx.builders.qthelp)</a></dt>
</dl></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-ref">ref (role)</a></dt>
    <dt><a href="markup/inline.html#role-regexp">regexp (role)</a></dt>
    <dt><a href="templating.html#relbar">relbar() (built-in function)</a></dt>
    <dt><a href="templating.html#reldelim1">reldelim1 (built-in variable)</a></dt>
    <dt><a href="templating.html#reldelim2">reldelim2 (built-in variable)</a></dt>
    <dt>release</dt>
    <dd><dl>
      <dt><a href="config.html#confval-release">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#release">release (built-in variable)</a></dt>
    <dt><a href="templating.html#rellinks">rellinks (built-in variable)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.TemplateBridge.render">render() (sphinx.application.TemplateBridge method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.TemplateBridge.render_string">render_string() (sphinx.application.TemplateBridge method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.require_sphinx">require_sphinx() (sphinx.application.Sphinx method)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.resolve_xref">resolve_xref() (sphinx.domains.Domain method)</a></dt>
    <dt><a href="markup/inline.html#role-rfc">rfc (role)</a></dt>
    <dt><a href="glossary.html#term-role">role</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.role">role() (sphinx.domains.Domain method)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.domains.Domain.roles">roles (sphinx.domains.Domain attribute)</a></dt>
    <dt><a href="domains.html#role-rst:dir">rst:dir (role)</a></dt>
    <dt><a href="domains.html#directive-rst:directive">rst:directive (directive)</a></dt>
    <dt><a href="domains.html#directive-rst:role">rst:role (directive)</a></dt>
    <dd><dl>
      <dt><a href="domains.html#role-rst:role">(role)</a></dt>
  </dl></dd>
    <dt>rst_epilog</dt>
    <dd><dl>
      <dt><a href="config.html#confval-rst_epilog">configuration value</a></dt>
  </dl></dd>
    <dt>rst_prolog</dt>
    <dd><dl>
      <dt><a href="config.html#confval-rst_prolog">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/para.html#directive-rubric">rubric (directive)</a></dt>
</dl></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/inline.html#role-samp">samp (role)</a></dt>
    <dt><a href="templating.html#script_files">script_files (built-in variable)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.SerializingHTMLBuilder.searchindex_filename">searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder attribute)</a></dt>
    <dt><a href="markup/misc.html#directive-sectionauthor">sectionauthor (directive)</a></dt>
    <dt><a href="markup/para.html#directive-seealso">seealso (directive)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.SerializingHTMLBuilder">SerializingHTMLBuilder (class in sphinx.builders.html)</a></dt>
    <dt><a href="ext/appapi.html#sphinx.application.Sphinx.setup_extension">setup_extension() (sphinx.application.Sphinx method)</a></dt>
    <dt><a href="templating.html#shorttitle">shorttitle (built-in variable)</a></dt>
    <dt>show_authors</dt>
    <dd><dl>
      <dt><a href="config.html#confval-show_authors">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#show_source">show_source (built-in variable)</a></dt>
    <dt><a href="templating.html#sidebar">sidebar() (built-in function)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.SingleFileHTMLBuilder">SingleFileHTMLBuilder (class in sphinx.builders.html)</a></dt>
    <dt>snippets</dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#index-0">testing</a></dt>
  </dl></dd>
    <dt><a href="glossary.html#term-source-directory">source directory</a></dt>
    <dt>source-read</dt>
    <dd><dl>
      <dt><a href="ext/appapi.html#event-source-read">event</a></dt>
  </dl></dd>
    <dt>source_encoding</dt>
    <dd><dl>
      <dt><a href="config.html#confval-source_encoding">configuration value</a></dt>
  </dl></dd>
    <dt>source_suffix</dt>
    <dd><dl>
      <dt><a href="config.html#confval-source_suffix">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/code.html#index-0">sourcecode</a></dt>
    <dt><a href="templating.html#sourcename">sourcename (built-in variable)</a></dt>
    <dt><a href="extensions.html#module-sphinx.application">sphinx.application (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders">sphinx.builders (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.changes">sphinx.builders.changes (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.devhelp">sphinx.builders.devhelp (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.epub">sphinx.builders.epub (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.html">sphinx.builders.html (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.htmlhelp">sphinx.builders.htmlhelp (module)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="builders.html#module-sphinx.builders.latex">sphinx.builders.latex (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.linkcheck">sphinx.builders.linkcheck (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.manpage">sphinx.builders.manpage (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.qthelp">sphinx.builders.qthelp (module)</a></dt>
    <dt><a href="builders.html#module-sphinx.builders.text">sphinx.builders.text (module)</a></dt>
    <dt><a href="ext/appapi.html#module-sphinx.domains">sphinx.domains (module)</a></dt>
    <dt><a href="ext/autodoc.html#module-sphinx.ext.autodoc">sphinx.ext.autodoc (module)</a></dt>
    <dt><a href="ext/autosummary.html#module-sphinx.ext.autosummary">sphinx.ext.autosummary (module)</a></dt>
    <dt><a href="ext/coverage.html#module-sphinx.ext.coverage">sphinx.ext.coverage (module)</a></dt>
    <dt><a href="ext/doctest.html#module-sphinx.ext.doctest">sphinx.ext.doctest (module)</a></dt>
    <dt><a href="ext/extlinks.html#module-sphinx.ext.extlinks">sphinx.ext.extlinks (module)</a></dt>
    <dt><a href="ext/graphviz.html#module-sphinx.ext.graphviz">sphinx.ext.graphviz (module)</a></dt>
    <dt><a href="ext/ifconfig.html#module-sphinx.ext.ifconfig">sphinx.ext.ifconfig (module)</a></dt>
    <dt><a href="ext/inheritance.html#module-sphinx.ext.inheritance_diagram">sphinx.ext.inheritance_diagram (module)</a></dt>
    <dt><a href="ext/intersphinx.html#module-sphinx.ext.intersphinx">sphinx.ext.intersphinx (module)</a></dt>
    <dt><a href="ext/math.html#module-sphinx.ext.jsmath">sphinx.ext.jsmath (module)</a></dt>
    <dt><a href="ext/math.html#module-sphinx.ext.mathbase">sphinx.ext.mathbase (module)</a></dt>
    <dt><a href="ext/oldcmarkup.html#module-sphinx.ext.oldcmarkup">sphinx.ext.oldcmarkup (module)</a></dt>
    <dt><a href="ext/math.html#module-sphinx.ext.pngmath">sphinx.ext.pngmath (module)</a></dt>
    <dt><a href="ext/refcounting.html#module-sphinx.ext.refcounting">sphinx.ext.refcounting (module)</a></dt>
    <dt><a href="ext/todo.html#module-sphinx.ext.todo">sphinx.ext.todo (module)</a></dt>
    <dt><a href="ext/viewcode.html#module-sphinx.ext.viewcode">sphinx.ext.viewcode (module)</a></dt>
    <dt><a href="templating.html#sphinx_version">sphinx_version (built-in variable)</a></dt>
    <dt><a href="builders.html#sphinx.builders.html.StandaloneHTMLBuilder">StandaloneHTMLBuilder (class in sphinx.builders.html)</a></dt>
    <dt><a href="templating.html#style">style (built-in variable)</a></dt>
    <dt>substitutions</dt>
    <dd><dl>
      <dt><a href="config.html#index-0">global</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt>table of</dt>
    <dd><dl>
      <dt><a href="markup/toctree.html#index-0">contents</a></dt>
  </dl></dd>
    <dt><a href="markup/misc.html#directive-tabularcolumns">tabularcolumns (directive)</a></dt>
    <dt>template_bridge</dt>
    <dd><dl>
      <dt><a href="config.html#confval-template_bridge">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/appapi.html#sphinx.application.TemplateBridge">TemplateBridge (class in sphinx.application)</a></dt>
    <dt>templates_path</dt>
    <dd><dl>
      <dt><a href="config.html#confval-templates_path">configuration value</a></dt>
  </dl></dd>
    <dt><a href="markup/inline.html#role-term">term (role)</a></dt>
    <dt><a href="ext/doctest.html#directive-testcode">testcode (directive)</a></dt>
    <dt>testing</dt>
    <dd><dl>
      <dt><a href="ext/doctest.html#index-0">automatic</a></dt>
      <dt><a href="ext/doctest.html#index-0">snippets</a></dt>
  </dl></dd>
    <dt><a href="ext/doctest.html#directive-testoutput">testoutput (directive)</a></dt>
    <dt><a href="ext/doctest.html#directive-testsetup">testsetup (directive)</a></dt>
    <dt><a href="builders.html#sphinx.builders.text.TextBuilder">TextBuilder (class in sphinx.builders.text)</a></dt>
    <dt><a href="domains.html#theclass::const_iterator">theclass::const_iterator (C++ type)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="domains.html#theclass::name__ss">theclass::name (C++ member)</a></dt>
    <dt><a href="templating.html#title">title (built-in variable)</a></dt>
    <dt><a href="templating.html#toc">toc (built-in variable)</a></dt>
    <dt><a href="templating.html#toctree">toctree (built-in variable)</a></dt>
    <dd><dl>
      <dt><a href="markup/toctree.html#directive-toctree">(directive)</a></dt>
  </dl></dd>
    <dt>today</dt>
    <dd><dl>
      <dt><a href="config.html#confval-today">configuration value</a></dt>
  </dl></dd>
    <dt>today_fmt</dt>
    <dd><dl>
      <dt><a href="config.html#confval-today_fmt">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/todo.html#directive-todo">todo (directive)</a></dt>
    <dt>todo_include_todos</dt>
    <dd><dl>
      <dt><a href="ext/todo.html#confval-todo_include_todos">configuration value</a></dt>
  </dl></dd>
    <dt><a href="ext/todo.html#directive-todolist">todolist (directive)</a></dt>
    <dt><a href="markup/inline.html#role-token">token (role)</a></dt>
    <dt>trim_doctest_flags</dt>
    <dd><dl>
      <dt><a href="config.html#confval-trim_doctest_flags">configuration value</a></dt>
  </dl></dd>
    <dt>trim_footnote_reference_space</dt>
    <dd><dl>
      <dt><a href="config.html#confval-trim_footnote_reference_space">configuration value</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/autosummary.html#underline">underline (built-in variable)</a></dt>
    <dt>unused_docs</dt>
    <dd><dl>
      <dt><a href="config.html#confval-unused_docs">configuration value</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="templating.html#use_opensearch">use_opensearch (built-in variable)</a></dt>
</dl></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt>version</dt>
    <dd><dl>
      <dt><a href="config.html#confval-version">configuration value</a></dt>
  </dl></dd>
    <dt><a href="templating.html#version">version (built-in variable)</a></dt>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/para.html#directive-versionadded">versionadded (directive)</a></dt>
    <dt><a href="markup/para.html#directive-versionchanged">versionchanged (directive)</a></dt>
</dl></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="markup/para.html#index-0">warning</a></dt>
    <dd><dl>
      <dt><a href="markup/para.html#directive-warning">(directive)</a></dt>
  </dl></dd>
</dl></td>
  <td style="width: 33%" valign="top"><dl>
    <dt><a href="ext/builderapi.html#sphinx.builders.Builder.write_doc">write_doc() (sphinx.builders.Builder method)</a></dt>
</dl></td>
</tr></table>



          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">Sphinx home</a>&nbsp;|&nbsp;</li>
        <li><a href="contents.html">Documentation</a>
          &raquo;</li>
 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2007-2011, Georg Brandl.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
  </body>
</html>