<!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>Invocation of sphinx-build — 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="reStructuredText Primer" href="rest.html" />
<link rel="prev" title="First Steps with Sphinx" href="tutorial.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="rest.html" title="reStructuredText Primer"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="First Steps with Sphinx"
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">
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Invocation of sphinx-build</a><ul>
<li><a class="reference internal" href="#makefile-options">Makefile options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#invocation-of-sphinx-apidoc">Invocation of sphinx-apidoc</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="tutorial.html"
title="previous chapter">First Steps with Sphinx</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="rest.html"
title="next chapter">reStructuredText Primer</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/invocation.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="invocation-of-sphinx-build">
<span id="invocation"></span><h1>Invocation of sphinx-build<a class="headerlink" href="#invocation-of-sphinx-build" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="program">sphinx-build</strong> script builds a Sphinx documentation set. It is
called like this:</p>
<div class="highlight-python"><pre>$ sphinx-build [options] sourcedir builddir [filenames]</pre>
</div>
<p>where <em>sourcedir</em> is the <a class="reference internal" href="glossary.html#term-source-directory"><em class="xref std std-term">source directory</em></a>, and <em>builddir</em> is the
directory in which you want to place the built documentation. Most of the time,
you don’t need to specify any <em>filenames</em>.</p>
<p>The <strong class="program">sphinx-build</strong> script has several options:</p>
<dl class="option">
<dt id="cmdoption-sphinx-build-b">
<tt class="descname">-b</tt><tt class="descclassname"> buildername</tt><a class="headerlink" href="#cmdoption-sphinx-build-b" title="Permalink to this definition">¶</a></dt>
<dd><p>The most important option: it selects a builder. The most common builders
are:</p>
<dl class="docutils">
<dt><strong>html</strong></dt>
<dd>Build HTML pages. This is the default builder.</dd>
<dt><strong>dirhtml</strong></dt>
<dd>Build HTML pages, but with a single directory per document. Makes for
prettier URLs (no <tt class="docutils literal"><span class="pre">.html</span></tt>) if served from a webserver.</dd>
<dt><strong>singlehtml</strong></dt>
<dd>Build a single HTML with the whole content.</dd>
<dt><strong>htmlhelp</strong>, <strong>qthelp</strong>, <strong>devhelp</strong>, <strong>epub</strong></dt>
<dd>Build HTML files with additional information for building a documentation
collection in one of these formats.</dd>
<dt><strong>latex</strong></dt>
<dd>Build LaTeX sources that can be compiled to a PDF document using
<strong class="program">pdflatex</strong>.</dd>
<dt><strong>man</strong></dt>
<dd>Build manual pages in groff format for UNIX systems.</dd>
<dt><strong>texinfo</strong></dt>
<dd>Build Texinfo files that can be processed into Info files using
<strong class="program">makeinfo</strong>.</dd>
<dt><strong>text</strong></dt>
<dd>Build plain text files.</dd>
<dt><strong>gettext</strong></dt>
<dd>Build gettext-style message catalogs (<tt class="docutils literal"><span class="pre">.pot</span></tt> files).</dd>
<dt><strong>doctest</strong></dt>
<dd>Run all doctests in the documentation, if the <a class="reference internal" href="ext/doctest.html#module-sphinx.ext.doctest" title="sphinx.ext.doctest: Test snippets in the documentation."><tt class="xref py py-mod docutils literal"><span class="pre">doctest</span></tt></a>
extension is enabled.</dd>
<dt><strong>linkcheck</strong></dt>
<dd>Check the integrity of all external links.</dd>
</dl>
<p>See <a class="reference internal" href="builders.html#builders"><em>Available builders</em></a> for a list of all builders shipped with Sphinx.
Extensions can add their own builders.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-a">
<tt class="descname">-a</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-a" title="Permalink to this definition">¶</a></dt>
<dd><p>If given, always write all output files. The default is to only write output
files for new and changed source files. (This may not apply to all
builders.)</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-E">
<tt class="descname">-E</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-E" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t use a saved <a class="reference internal" href="glossary.html#term-environment"><em class="xref std std-term">environment</em></a> (the structure caching all
cross-references), but rebuild it completely. The default is to only read
and parse source files that are new or have changed since the last run.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-t">
<tt class="descname">-t</tt><tt class="descclassname"> tag</tt><a class="headerlink" href="#cmdoption-sphinx-build-t" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the tag <em>tag</em>. This is relevant for <a class="reference internal" href="markup/misc.html#directive-only" title="only directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">only</span></tt></a> directives that only
include their content if this tag is set.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.6.</span></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-d">
<tt class="descname">-d</tt><tt class="descclassname"> path</tt><a class="headerlink" href="#cmdoption-sphinx-build-d" title="Permalink to this definition">¶</a></dt>
<dd><p>Since Sphinx has to read and parse all source files before it can write an
output file, the parsed source files are cached as “doctree pickles”.
Normally, these files are put in a directory called <tt class="file docutils literal"><span class="pre">.doctrees</span></tt> under
the build directory; with this option you can select a different cache
directory (the doctrees can be shared between all builders).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-c">
<tt class="descname">-c</tt><tt class="descclassname"> path</tt><a class="headerlink" href="#cmdoption-sphinx-build-c" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t look for the <tt class="file docutils literal"><span class="pre">conf.py</span></tt> in the source directory, but use the given
configuration directory instead. Note that various other files and paths
given by configuration values are expected to be relative to the
configuration directory, so they will have to be present at this location
too.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.3.</span></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-C">
<tt class="descname">-C</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-C" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t look for a configuration file; only take options via the <tt class="docutils literal"><span class="pre">-D</span></tt> option.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-D">
<tt class="descname">-D</tt><tt class="descclassname"> setting=value</tt><a class="headerlink" href="#cmdoption-sphinx-build-D" title="Permalink to this definition">¶</a></dt>
<dd><p>Override a configuration value set in the <tt class="file docutils literal"><span class="pre">conf.py</span></tt> file. The value
must be a string or dictionary value. For the latter, supply the setting
name and key like this: <tt class="docutils literal"><span class="pre">-D</span> <span class="pre">latex_elements.docclass=scrartcl</span></tt>. For boolean
values, use <tt class="docutils literal"><span class="pre">0</span></tt> or <tt class="docutils literal"><span class="pre">1</span></tt> as the value.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 0.6: </span>The value can now be a dictionary value.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-A">
<tt class="descname">-A</tt><tt class="descclassname"> name=value</tt><a class="headerlink" href="#cmdoption-sphinx-build-A" title="Permalink to this definition">¶</a></dt>
<dd><p>Make the <em>name</em> assigned to <em>value</em> in the HTML templates.</p>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-n">
<tt class="descname">-n</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-n" title="Permalink to this definition">¶</a></dt>
<dd><p>Run in nit-picky mode. Currently, this generates warnings for all missing
references.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-N">
<tt class="descname">-N</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-N" title="Permalink to this definition">¶</a></dt>
<dd><p>Do not emit colored output. (On Windows, colored output is disabled in any
case.)</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-q">
<tt class="descname">-q</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-q" title="Permalink to this definition">¶</a></dt>
<dd><p>Do not output anything on standard output, only write warnings and errors to
standard error.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-Q">
<tt class="descname">-Q</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-Q" title="Permalink to this definition">¶</a></dt>
<dd><p>Do not output anything on standard output, also suppress warnings. Only
errors are written to standard error.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-w">
<tt class="descname">-w</tt><tt class="descclassname"> file</tt><a class="headerlink" href="#cmdoption-sphinx-build-w" title="Permalink to this definition">¶</a></dt>
<dd><p>Write warnings (and errors) to the given file, in addition to standard error.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-W">
<tt class="descname">-W</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-W" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn warnings into errors. This means that the build stops at the first
warning and <tt class="docutils literal"><span class="pre">sphinx-build</span></tt> exits with exit status 1.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-build-P">
<tt class="descname">-P</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-build-P" title="Permalink to this definition">¶</a></dt>
<dd><p>(Useful for debugging only.) Run the Python debugger, <tt class="xref py py-mod docutils literal"><span class="pre">pdb</span></tt>, if an
unhandled exception occurs while building.</p>
</dd></dl>
<p>You can also give one or more filenames on the command line after the source and
build directories. Sphinx will then try to build only these output files (and
their dependencies).</p>
<div class="section" id="makefile-options">
<h2>Makefile options<a class="headerlink" href="#makefile-options" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="file docutils literal"><span class="pre">Makefile</span></tt> and <tt class="file docutils literal"><span class="pre">make.bat</span></tt> files created by
<strong class="program">sphinx-quickstart</strong> usually run <strong class="program">sphinx-build</strong> only with the
<a class="reference internal" href="#cmdoption-sphinx-build-b"><em class="xref std std-option">-b</em></a> and <a class="reference internal" href="#cmdoption-sphinx-build-d"><em class="xref std std-option">-d</em></a> options. However, they support the following
variables to customize behavior:</p>
<dl class="describe">
<dt>
<tt class="descname">PAPER</tt></dt>
<dd><p>The value for <a class="reference internal" href="config.html#confval-latex_paper_size"><tt class="xref std std-confval docutils literal"><span class="pre">latex_paper_size</span></tt></a>.</p>
</dd></dl>
<dl class="describe">
<dt>
<tt class="descname">SPHINXBUILD</tt></dt>
<dd><p>The command to use instead of <tt class="docutils literal"><span class="pre">sphinx-build</span></tt>.</p>
</dd></dl>
<dl class="describe">
<dt>
<tt class="descname">BUILDDIR</tt></dt>
<dd><p>The build directory to use instead of the one chosen in
<strong class="program">sphinx-quickstart</strong>.</p>
</dd></dl>
<dl class="describe">
<dt>
<tt class="descname">SPHINXOPTS</tt></dt>
<dd><p>Additional options for <strong class="program">sphinx-build</strong>.</p>
</dd></dl>
</div>
</div>
<div class="section" id="invocation-of-sphinx-apidoc">
<span id="invocation-apidoc"></span><h1>Invocation of sphinx-apidoc<a class="headerlink" href="#invocation-of-sphinx-apidoc" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="program">sphinx-apidoc</strong> generates completely automatic API documentation
for a Python package. It is called like this:</p>
<div class="highlight-python"><pre>$ sphinx-apidoc [options] -o outputdir packagedir [pathnames]</pre>
</div>
<p>where <em>packagedir</em> is the path to the package to document, and <em>outputdir</em> is
the directory where the generated sources are placed. Any <em>pathnames</em> given
are paths to be excluded ignored during generation.</p>
<p>The <strong class="program">sphinx-apidoc</strong> script has several options:</p>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-o">
<tt class="descname">-o</tt><tt class="descclassname"> outputdir</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-o" title="Permalink to this definition">¶</a></dt>
<dd><p>Gives the directory in which to place the generated output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-f">
<tt class="descname">-f</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--force</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-f" title="Permalink to this definition">¶</a></dt>
<dd><p>Normally, sphinx-apidoc does not overwrite any files. Use this option to
force the overwrite of all files that it generates.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-n">
<tt class="descname">-n</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--dry-run</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-n" title="Permalink to this definition">¶</a></dt>
<dd><p>With this option given, no files will be written at all.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-s">
<tt class="descname">-s</tt><tt class="descclassname"> suffix</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-s" title="Permalink to this definition">¶</a></dt>
<dd><p>This option selects the file name suffix of output files. By default, this
is <tt class="docutils literal"><span class="pre">rst</span></tt>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-d">
<tt class="descname">-d</tt><tt class="descclassname"> maxdepth</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-d" title="Permalink to this definition">¶</a></dt>
<dd><p>This sets the maximum depth of the table of contents, if one is generated.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-T">
<tt class="descname">-T</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--no-toc</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-T" title="Permalink to this definition">¶</a></dt>
<dd><p>This prevents the generation of a table-of-contents file <tt class="docutils literal"><span class="pre">modules.rst</span></tt>.
This has no effect when <em class="xref std std-option">--full</em> is given.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-F">
<tt class="descname">-F</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--full</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-F" title="Permalink to this definition">¶</a></dt>
<dd><p>This option makes sphinx-apidoc create a full Sphinx project, using the same
mechanism as <strong class="program">sphinx-quickstart</strong>. Most configuration values are set
to default values, but you can influence the most important ones using the
following options.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-H">
<tt class="descname">-H</tt><tt class="descclassname"> project</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-H" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the project name to put in generated files (see <a class="reference internal" href="config.html#confval-project"><tt class="xref std std-confval docutils literal"><span class="pre">project</span></tt></a>).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-A">
<tt class="descname">-A</tt><tt class="descclassname"> author</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-A" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the author name(s) to put in generated files (see <a class="reference internal" href="config.html#confval-copyright"><tt class="xref std std-confval docutils literal"><span class="pre">copyright</span></tt></a>).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-V">
<tt class="descname">-V</tt><tt class="descclassname"> version</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-V" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the project version to put in generated files (see <a class="reference internal" href="config.html#confval-version"><tt class="xref std std-confval docutils literal"><span class="pre">version</span></tt></a>).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-R">
<tt class="descname">-R</tt><tt class="descclassname"> release</tt><a class="headerlink" href="#cmdoption-sphinx-apidoc-R" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the project release to put in generated files (see <a class="reference internal" href="config.html#confval-release"><tt class="xref std std-confval docutils literal"><span class="pre">release</span></tt></a>).</p>
</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="rest.html" title="reStructuredText Primer"
>next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="First Steps with Sphinx"
>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
>
122
