/usr/share/doc/sphinx-doc/html/glossary.html

<!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>Glossary &#8212; Sphinx 1.6.7 documentation</title>
    <link rel="stylesheet" href="_static/sphinx13.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.6.7',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </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.6.7 documentation"
          href="_static/opensearch.xml"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Sphinx Developer’s Guide" href="devguide.html" />
    <link rel="prev" title="Sphinx FAQ" href="faq.html" />
 
    <style type="text/css">
      table.right { float: right; margin-left: 20px; }
      table.right td { border: 1px solid #ccc; }
      
    </style>
    <script type="text/javascript">
      // intelligent scrolling of the sidebar content
      $(window).scroll(function() {
        var sb = $('.sphinxsidebarwrapper');
        var win = $(window);
        var sbh = sb.height();
        var offset = $('.sphinxsidebar').position()['top'];
        var wintop = win.scrollTop();
        var winbot = wintop + win.innerHeight();
        var curtop = sb.position()['top'];
        var curbot = curtop + sbh;
        // does sidebar fit in window?
        if (sbh < win.innerHeight()) {
          // yes: easy case -- always keep at the top
          sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
                                $(document).height() - sbh - 200]));
        } else {
          // no: only scroll if top/bottom edge of sidebar is at
          // top/bottom edge of window
          if (curtop > wintop && curbot > winbot) {
            sb.css('top', $u.max([wintop - offset - 10, 0]));
          } else if (curtop < wintop && curbot < winbot) {
            sb.css('top', $u.min([winbot - sbh - offset - 20,
                                  $(document).height() - sbh - 200]));
          }
        }
      });
    </script>

  </head>
  <body>
<div class="pageheader">
  <ul>
    <li><a href="index.html">Home</a></li>
    <li><a href="install.html">Get it</a></li>
    <li><a href="contents.html">Docs</a></li>
    <li><a href="develop.html">Extend/Develop</a></li>
  </ul>
  <div>
    <a href="index.html">
      <img src="_static/sphinxheader.png" alt="SPHINX" />
    </a>
  </div>
</div>

    <div class="related" role="navigation" aria-label="related navigation">
      <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="devguide.html" title="Sphinx Developer’s Guide"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="faq.html" title="Sphinx FAQ"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Sphinx home</a>&#160;|</li>
        <li><a href="contents.html">Documentation</a> &#187;</li>
 
      </ul>
    </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="faq.html"
                        title="previous chapter">Sphinx FAQ</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="devguide.html"
                        title="next chapter">Sphinx Developer’s Guide</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/glossary.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="glossary">
<span id="id1"></span><h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
<dl class="glossary docutils">
<dt id="term-builder">builder</dt>
<dd><p class="first">A class (inheriting from <a class="reference internal" href="extdev/builderapi.html#sphinx.builders.Builder" title="sphinx.builders.Builder"><code class="xref py py-class docutils literal"><span class="pre">Builder</span></code></a>) that takes
parsed documents and performs an action on them.  Normally, builders
translate the documents to an output format, but it is also possible to
use the builder builders that e.g. check for broken links in the
documentation, or build coverage information.</p>
<p class="last">See <a class="reference internal" href="builders.html#builders"><span class="std std-ref">Available builders</span></a> for an overview over Sphinx’s built-in builders.</p>
</dd>
<dt id="term-configuration-directory">configuration directory</dt>
<dd>The directory containing <code class="file docutils literal"><span class="pre">conf.py</span></code>.  By default, this is the same as
the <a class="reference internal" href="#term-source-directory"><span class="xref std std-term">source directory</span></a>, but can be set differently with the <strong>-c</strong>
command-line option.</dd>
<dt id="term-directive">directive</dt>
<dd><p class="first">A reStructuredText markup element that allows marking a block of content
with special meaning.  Directives are supplied not only by docutils, but
Sphinx and custom extensions can add their own.  The basic directive
syntax looks like this:</p>
<div class="highlight-rst"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">directivename</span><span class="p">::</span> argument ...
   <span class="nc">:option:</span> <span class="nf">value</span>

   Content of the directive.
</pre></div>
</div>
<p class="last">See <a class="reference internal" href="rest.html#directives"><span class="std std-ref">Directives</span></a> for more information.</p>
</dd>
<dt id="term-document-name">document name</dt>
<dd><p class="first">Since reST source files can have different extensions (some people like
<code class="docutils literal"><span class="pre">.txt</span></code>, some like <code class="docutils literal"><span class="pre">.rst</span></code> – the extension can be configured with
<a class="reference internal" href="config.html#confval-source_suffix"><code class="xref std std-confval docutils literal"><span class="pre">source_suffix</span></code></a>) and different OSes have different path
separators, Sphinx abstracts them: <em class="dfn">document names</em> are always
relative to the <a class="reference internal" href="#term-source-directory"><span class="xref std std-term">source directory</span></a>, the extension is stripped, and
path separators are converted to slashes.  All values, parameters and such
referring to “documents” expect such document names.</p>
<p class="last">Examples for document names are <code class="docutils literal"><span class="pre">index</span></code>, <code class="docutils literal"><span class="pre">library/zipfile</span></code>, or
<code class="docutils literal"><span class="pre">reference/datamodel/types</span></code>.  Note that there is no leading or trailing
slash.</p>
</dd>
<dt id="term-domain">domain</dt>
<dd><p class="first">A domain is a collection of markup (reStructuredText <a class="reference internal" href="#term-directive"><span class="xref std std-term">directive</span></a>s
and <a class="reference internal" href="#term-role"><span class="xref std std-term">role</span></a>s) to describe and link to <a class="reference internal" href="#term-object"><span class="xref std std-term">object</span></a>s belonging
together, e.g. elements of a programming language.  Directive and role
names in a domain have names like <code class="docutils literal"><span class="pre">domain:name</span></code>, e.g. <code class="docutils literal"><span class="pre">py:function</span></code>.</p>
<p class="last">Having domains means that there are no naming problems when one set of
documentation wants to refer to e.g. C++ and Python classes.  It also
means that extensions that support the documentation of whole new
languages are much easier to write.  For more information about domains,
see the chapter <a class="reference internal" href="domains.html#domains"><span class="std std-ref">Sphinx Domains</span></a>.</p>
</dd>
<dt id="term-environment">environment</dt>
<dd>A structure where information about all documents under the root is saved,
and used for cross-referencing.  The environment is pickled after the
parsing stage, so that successive runs only need to read and parse new and
changed documents.</dd>
<dt id="term-master-document">master document</dt>
<dd>The document that contains the root <a class="reference internal" href="markup/toctree.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal"><span class="pre">toctree</span></code></a> directive.</dd>
<dt id="term-object">object</dt>
<dd>The basic building block of Sphinx documentation.  Every “object
directive” (e.g. <code class="xref rst rst-dir docutils literal"><span class="pre">function</span></code> or <a class="reference internal" href="domains.html#directive-object" title="object directive"><code class="xref rst rst-dir docutils literal"><span class="pre">object</span></code></a>) creates such a
block; and most objects can be cross-referenced to.</dd>
<dt id="term-removeinsphinxxxxwarning">RemoveInSphinxXXXWarning</dt>
<dd>The feature which is warned will be removed in Sphinx-XXX version.
It usually caused from Sphinx extensions which is using deprecated.
See also <a class="reference internal" href="invocation.html#when-deprecation-warnings-are-displayed"><span class="std std-ref">Deprecation Warnings</span></a>.</dd>
<dt id="term-role">role</dt>
<dd>A reStructuredText markup element that allows marking a piece of text.
Like directives, roles are extensible.  The basic syntax looks like this:
<code class="docutils literal"><span class="pre">:rolename:`content`</span></code>.  See <a class="reference internal" href="rest.html#inlinemarkup"><span class="std std-ref">Inline markup</span></a> for details.</dd>
<dt id="term-source-directory">source directory</dt>
<dd>The directory which, including its subdirectories, contains all source
files for one Sphinx project.</dd>
</dl>
</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <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="devguide.html" title="Sphinx Developer’s Guide"
             >next</a> |</li>
        <li class="right" >
          <a href="faq.html" title="Sphinx FAQ"
             >previous</a> |</li>
        <li><a href="index.html">Sphinx home</a>&#160;|</li>
        <li><a href="contents.html">Documentation</a> &#187;</li>
 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2007-2018, Georg Brandl and the Sphinx team.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
    </div>
  </body>
</html>
sphinx-doc 1.6.7-1ubuntu1 / usr / share / doc / sphinx-doc / html / glossary.html
