<!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 Markup Constructs — Sphinx 1.1.3 documentation</title> <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '1.1.3', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Sphinx 1.1.3 documentation" href="../_static/opensearch.xml"/> <link rel="top" title="Sphinx 1.1.3 documentation" href="../index.html" /> <link rel="next" title="The TOC tree" href="toctree.html" /> <link rel="prev" title="reStructuredText Primer" href="../rest.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="toctree.html" title="The TOC tree" accesskey="N">next</a> |</li> <li class="right" > <a href="../rest.html" title="reStructuredText Primer" accesskey="P">previous</a> |</li> <li><a href="../index.html">Sphinx home</a> | </li> <li><a href="../contents.html">Documentation</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="../rest.html" title="previous chapter">reStructuredText Primer</a></p> <h4>Next topic</h4> <p class="topless"><a href="toctree.html" title="next chapter">The TOC tree</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/markup/index.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-markup-constructs"> <span id="sphinxmarkup"></span><h1>Sphinx Markup Constructs<a class="headerlink" href="#sphinx-markup-constructs" title="Permalink to this headline">ΒΆ</a></h1> <p>Sphinx adds a lot of new directives and interpreted text roles to <a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html">standard reST markup</a>. This section contains the reference material for these facilities.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="toctree.html">The TOC tree</a><ul> <li class="toctree-l2"><a class="reference internal" href="toctree.html#special-names">Special names</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="para.html">Paragraph-level markup</a></li> <li class="toctree-l1"><a class="reference internal" href="para.html#table-of-contents-markup">Table-of-contents markup</a></li> <li class="toctree-l1"><a class="reference internal" href="para.html#glossary">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="para.html#grammar-production-displays">Grammar production displays</a></li> <li class="toctree-l1"><a class="reference internal" href="code.html">Showing code examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="code.html#line-numbers">Line numbers</a></li> <li class="toctree-l2"><a class="reference internal" href="code.html#includes">Includes</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="inline.html">Inline markup</a><ul> <li class="toctree-l2"><a class="reference internal" href="inline.html#cross-referencing-syntax">Cross-referencing syntax</a><ul> <li class="toctree-l3"><a class="reference internal" href="inline.html#cross-referencing-objects">Cross-referencing objects</a></li> <li class="toctree-l3"><a class="reference internal" href="inline.html#cross-referencing-arbitrary-locations">Cross-referencing arbitrary locations</a></li> <li class="toctree-l3"><a class="reference internal" href="inline.html#cross-referencing-documents">Cross-referencing documents</a></li> <li class="toctree-l3"><a class="reference internal" href="inline.html#referencing-downloadable-files">Referencing downloadable files</a></li> <li class="toctree-l3"><a class="reference internal" href="inline.html#cross-referencing-other-items-of-interest">Cross-referencing other items of interest</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="inline.html#other-semantic-markup">Other semantic markup</a></li> <li class="toctree-l2"><a class="reference internal" href="inline.html#substitutions">Substitutions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="misc.html">Miscellaneous markup</a><ul> <li class="toctree-l2"><a class="reference internal" href="misc.html#file-wide-metadata">File-wide metadata</a></li> <li class="toctree-l2"><a class="reference internal" href="misc.html#meta-information-markup">Meta-information markup</a></li> <li class="toctree-l2"><a class="reference internal" href="misc.html#index-generating-markup">Index-generating markup</a></li> <li class="toctree-l2"><a class="reference internal" href="misc.html#including-content-based-on-tags">Including content based on tags</a></li> <li class="toctree-l2"><a class="reference internal" href="misc.html#tables">Tables</a></li> </ul> </li> </ul> </div> <p>More markup is added by <a class="reference internal" href="../domains.html#domains"><em>Sphinx Domains</em></a>.</p> </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="toctree.html" title="The TOC tree" >next</a> |</li> <li class="right" > <a href="../rest.html" title="reStructuredText Primer" >previous</a> |</li> <li><a href="../index.html">Sphinx home</a> | </li> <li><a href="../contents.html">Documentation</a> »</li> </ul> </div> <div class="footer"> © Copyright 2007-2011, Georg Brandl. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>