<!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 — 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="Changes in Sphinx" href="changes.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>
</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="changes.html" title="Changes in Sphinx"
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> | </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="faq.html"
title="previous chapter">Sphinx FAQ</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="changes.html"
title="next chapter">Changes in Sphinx</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/glossary.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="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="ext/builderapi.html#sphinx.builders.Builder" title="sphinx.builders.Builder"><tt class="xref py py-class docutils literal"><span class="pre">Builder</span></tt></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"><em>Available builders</em></a> for an overview over Sphinx’ built-in builders.</p>
</dd>
<dt id="term-configuration-directory">configuration directory</dt>
<dd>The directory containing <tt class="file docutils literal"><span class="pre">conf.py</span></tt>. By default, this is the same as
the <a class="reference internal" href="#term-source-directory"><em class="xref std std-term">source directory</em></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"><pre>.. directivename:: argument ...
:option: value
Content of the directive.</pre>
</div>
<p class="last">See <a class="reference internal" href="rest.html#directives"><em>Directives</em></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
<tt class="docutils literal"><span class="pre">.txt</span></tt>, some like <tt class="docutils literal"><span class="pre">.rst</span></tt> – the extension can be configured with
<a class="reference internal" href="config.html#confval-source_suffix"><tt class="xref std std-confval docutils literal"><span class="pre">source_suffix</span></tt></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"><em class="xref std std-term">source directory</em></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 <tt class="docutils literal"><span class="pre">index</span></tt>, <tt class="docutils literal"><span class="pre">library/zipfile</span></tt>, or
<tt class="docutils literal"><span class="pre">reference/datamodel/types</span></tt>. 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"><em class="xref std std-term">directive</em></a>s
and <a class="reference internal" href="#term-role"><em class="xref std std-term">role</em></a>s) to describe and link to <a class="reference internal" href="#term-object"><em class="xref std std-term">object</em></a>s belonging
together, e.g. elements of a programming language. Directive and role
names in a domain have names like <tt class="docutils literal"><span class="pre">domain:name</span></tt>, e.g. <tt class="docutils literal"><span class="pre">py:function</span></tt>.</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"><em>Sphinx Domains</em></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"><tt class="xref rst rst-dir docutils literal"><span class="pre">toctree</span></tt></a> directive.</dd>
<dt id="term-object">object</dt>
<dd>The basic building block of Sphinx documentation. Every “object
directive” (e.g. <tt class="xref rst rst-dir docutils literal"><span class="pre">function</span></tt> or <a class="reference internal" href="domains.html#directive-object" title="object directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">object</span></tt></a>) creates such a block;
and most objects can be cross-referenced to.</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:
<tt class="docutils literal"><span class="pre">:rolename:`content`</span></tt>. See <a class="reference internal" href="rest.html#inlinemarkup"><em>Inline markup</em></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">
<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="changes.html" title="Changes in Sphinx"
>next</a> |</li>
<li class="right" >
<a href="faq.html" title="Sphinx FAQ"
>previous</a> |</li>
<li><a href="index.html">Sphinx home</a> | </li>
<li><a href="contents.html">Documentation</a>
»</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2011, Georg Brandl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Mageia
>
4
>
i586
>
media
>
core-release
>
by-pkgid
>
c95717a2237548a7bdaddf39c85b0f0f
>
files
>
118
