/usr/share/doc/sphinx-doc/html/invocation.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>Invocation of sphinx-quickstart &#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="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>
    <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="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>&#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">
  <h3><a href="contents.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Invocation of sphinx-quickstart</a><ul>
<li><a class="reference internal" href="#structure-options">Structure options</a></li>
<li><a class="reference internal" href="#project-basic-options">Project basic options</a></li>
<li><a class="reference internal" href="#extension-options">Extension options</a></li>
<li><a class="reference internal" href="#makefile-and-batchfile-creation-options">Makefile and Batchfile creation options</a></li>
<li><a class="reference internal" href="#project-templating">Project templating</a></li>
</ul>
</li>
<li><a class="reference internal" href="#invocation-of-sphinx-build">Invocation of sphinx-build</a><ul>
<li><a class="reference internal" href="#environment-variables">Environment variables</a></li>
<li><a class="reference internal" href="#makefile-options">Makefile options</a></li>
<li><a class="reference internal" href="#deprecation-warnings">Deprecation Warnings</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>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/invocation.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="invocation-of-sphinx-quickstart">
<span id="invocation"></span><h1>Invocation of sphinx-quickstart<a class="headerlink" href="#invocation-of-sphinx-quickstart" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="program">sphinx-quickstart</strong> script generates a Sphinx documentation set.
It is called like this:</p>
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sphinx-quickstart <span class="o">[</span>options<span class="o">]</span> <span class="o">[</span>projectdir<span class="o">]</span>
</pre></div>
</div>
<p>where <em>projectdir</em> is the Sphinx documentation set directory in which you want
to place. If you omit <em>projectdir</em>, files are generated into current directory
by default.</p>
<p>The <strong class="program">sphinx-quickstart</strong> script has several options:</p>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-q">
<code class="descname">-q</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-q" title="Permalink to this definition">¶</a></dt>
<dd><p>Quiet mode that will skips interactive wizard to specify options.
This option requires <a class="reference internal" href="#cmdoption-sphinx-quickstart-p"><code class="xref any std std-option docutils literal"><span class="pre">-p</span></code></a>, <a class="reference internal" href="#cmdoption-sphinx-quickstart-a"><code class="xref any std std-option docutils literal"><span class="pre">-a</span></code></a> and <a class="reference internal" href="#cmdoption-sphinx-quickstart-v"><code class="xref any std std-option docutils literal"><span class="pre">-v</span></code></a> options.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-h" title="Permalink to this definition">¶</a></dt>
<dd><p>Display usage summary or Sphinx version.</p>
</dd></dl>

<div class="section" id="structure-options">
<h2>Structure options<a class="headerlink" href="#structure-options" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-sep">
<code class="descname">--sep</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-sep" title="Permalink to this definition">¶</a></dt>
<dd><p>If specified, separate source and build directories.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-dot">
<code class="descname">--dot</code><code class="descclassname">=DOT</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-dot" title="Permalink to this definition">¶</a></dt>
<dd><p>Inside the root directory, two more directories will be created;
“_templates” for custom HTML templates and “_static” for custom stylesheets
and other static files. You can enter another prefix (such as “.”) to
replace the underscore.</p>
</dd></dl>

</div>
<div class="section" id="project-basic-options">
<h2>Project basic options<a class="headerlink" href="#project-basic-options" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-p">
<code class="descname">-p</code><code class="descclassname"> PROJECT</code><code class="descclassname">, </code><code class="descname">--project</code><code class="descclassname">=PROJECT</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-p" title="Permalink to this definition">¶</a></dt>
<dd><p>Project name will be set. (see <a class="reference internal" href="setuptools.html#confval-project"><code class="xref std std-confval docutils literal"><span class="pre">project</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-a">
<code class="descname">-a</code><code class="descclassname"> AUTHOR</code><code class="descclassname">, </code><code class="descname">--author</code><code class="descclassname">=AUTHOR</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-a" title="Permalink to this definition">¶</a></dt>
<dd><p>Author names. (see <a class="reference internal" href="setuptools.html#confval-copyright"><code class="xref std std-confval docutils literal"><span class="pre">copyright</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-v">
<code class="descname">-v</code><code class="descclassname"> VERSION</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-v" title="Permalink to this definition">¶</a></dt>
<dd><p>Version of project. (see <a class="reference internal" href="setuptools.html#confval-version"><code class="xref std std-confval docutils literal"><span class="pre">version</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-r">
<code class="descname">-r</code><code class="descclassname"> RELEASE</code><code class="descclassname">, </code><code class="descname">--release</code><code class="descclassname">=RELEASE</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-r" title="Permalink to this definition">¶</a></dt>
<dd><p>Release of project. (see <a class="reference internal" href="setuptools.html#confval-release"><code class="xref std std-confval docutils literal"><span class="pre">release</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-l">
<code class="descname">-l</code><code class="descclassname"> LANGUAGE</code><code class="descclassname">, </code><code class="descname">--language</code><code class="descclassname">=LANGUAGE</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-l" title="Permalink to this definition">¶</a></dt>
<dd><p>Document language. (see <a class="reference internal" href="config.html#confval-language"><code class="xref std std-confval docutils literal"><span class="pre">language</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-suffix">
<code class="descname">--suffix</code><code class="descclassname">=SUFFIX</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-suffix" title="Permalink to this definition">¶</a></dt>
<dd><p>Source file suffix. (see <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>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-master">
<code class="descname">--master</code><code class="descclassname">=MASTER</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-master" title="Permalink to this definition">¶</a></dt>
<dd><p>Master document name. (see <a class="reference internal" href="config.html#confval-master_doc"><code class="xref std std-confval docutils literal"><span class="pre">master_doc</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-epub">
<code class="descname">--epub</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-epub" title="Permalink to this definition">¶</a></dt>
<dd><p>Use epub.</p>
</dd></dl>

</div>
<div class="section" id="extension-options">
<h2>Extension options<a class="headerlink" href="#extension-options" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-autodoc">
<code class="descname">--ext-autodoc</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-autodoc" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/autodoc.html#module-sphinx.ext.autodoc" title="sphinx.ext.autodoc: Include documentation from docstrings."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.autodoc</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-doctest">
<code class="descname">--ext-doctest</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-doctest" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/doctest.html#module-sphinx.ext.doctest" title="sphinx.ext.doctest: Test snippets in the documentation."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.doctest</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-intersphinx">
<code class="descname">--ext-intersphinx</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-intersphinx" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.intersphinx</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-todo">
<code class="descname">--ext-todo</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-todo" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/todo.html#module-sphinx.ext.todo" title="sphinx.ext.todo: Allow inserting todo items into documents."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.todo</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-coverage">
<code class="descname">--ext-coverage</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-coverage" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/coverage.html#module-sphinx.ext.coverage" title="sphinx.ext.coverage: Check Python modules and C API for coverage in the documentation."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.coverage</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-imgmath">
<code class="descname">--ext-imgmath</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-imgmath" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/math.html#module-sphinx.ext.imgmath" title="sphinx.ext.imgmath: Render math as PNG or SVG images."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.imgmath</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-mathjax">
<code class="descname">--ext-mathjax</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-mathjax" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/math.html#module-sphinx.ext.mathjax" title="sphinx.ext.mathjax: Render math using JavaScript via MathJax."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.mathjax</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-ifconfig">
<code class="descname">--ext-ifconfig</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-ifconfig" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/ifconfig.html#module-sphinx.ext.ifconfig" title="sphinx.ext.ifconfig: Include documentation content based on configuration values."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.ifconfig</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-ext-viewcode">
<code class="descname">--ext-viewcode</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-ext-viewcode" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable <a class="reference internal" href="ext/viewcode.html#module-sphinx.ext.viewcode" title="sphinx.ext.viewcode: Add links to a highlighted version of the source code."><code class="xref any py py-mod docutils literal"><span class="pre">sphinx.ext.viewcode</span></code></a> extension.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-extensions">
<code class="descname">--extensions</code><code class="descclassname">=EXTENSIONS</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-extensions" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable arbitary extensions.</p>
</dd></dl>

</div>
<div class="section" id="makefile-and-batchfile-creation-options">
<h2>Makefile and Batchfile creation options<a class="headerlink" href="#makefile-and-batchfile-creation-options" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-use-make-mode">
<code class="descname">--use-make-mode</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--no-use-make-mode</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-use-make-mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Makefile/make.bat uses (or not use) make-mode. Default is use.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.5: </span>make-mode is default.</p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-makefile">
<code class="descname">--makefile</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--no-makefile</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-makefile" title="Permalink to this definition">¶</a></dt>
<dd><p>Create (or not create) makefile.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-batchfile">
<code class="descname">--batchfile</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--no-batchfile</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-quickstart-batchfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Create (or not create) batchfile</p>
</dd></dl>

<div class="versionadded">
<p><span class="versionmodified">New in version 1.3: </span>Add various options for sphinx-quickstart invocation.</p>
</div>
</div>
<div class="section" id="project-templating">
<h2>Project templating<a class="headerlink" href="#project-templating" title="Permalink to this headline">¶</a></h2>
<dl class="option">
<dt id="cmdoption-sphinx-quickstart-t">
<code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--templatedir</code><code class="descclassname">=TEMPLATEDIR</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-t" title="Permalink to this definition">¶</a></dt>
<dd><p>Template directory for template files.  You can modify the templates of
sphinx project files generated by quickstart.  Following Jinja2 template
files are allowed:</p>
<ul class="simple">
<li>master_doc.rst_t</li>
<li>conf.py_t</li>
<li>Makefile_t</li>
<li>Makefile.new_t</li>
<li>make.bat_t</li>
<li>make.bat.new_t</li>
</ul>
<p>In detail, please refer the system template files Sphinx provides.
(sphinx/templates/quickstart)</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-quickstart-d">
<code class="descname">-d</code><code class="descclassname"> NAME=VALUE</code><a class="headerlink" href="#cmdoption-sphinx-quickstart-d" title="Permalink to this definition">¶</a></dt>
<dd><p>Define a template variable</p>
</dd></dl>

<div class="versionadded">
<p><span class="versionmodified">New in version 1.5: </span>Project templating options for sphinx-quickstart</p>
</div>
</div>
</div>
<div class="section" id="invocation-of-sphinx-build">
<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-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sphinx-build <span class="o">[</span>options<span class="o">]</span> sourcedir builddir <span class="o">[</span>filenames<span class="o">]</span>
</pre></div>
</div>
<p>where <em>sourcedir</em> is the <a class="reference internal" href="glossary.html#term-source-directory"><span class="xref std std-term">source directory</span></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">
<code class="descname">-b</code><code class="descclassname"> buildername</code><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 <code class="docutils literal"><span class="pre">.html</span></code>) 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>applehelp</strong></dt>
<dd>Build an Apple Help Book.  Requires <strong class="program">hiutil</strong> and
<strong class="program">codesign</strong>, which are not Open Source and presently only
available on Mac OS X 10.6 and higher.</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 (<code class="docutils literal"><span class="pre">.pot</span></code> 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."><code class="xref py py-mod docutils literal"><span class="pre">doctest</span></code></a>
extension is enabled.</dd>
<dt><strong>linkcheck</strong></dt>
<dd>Check the integrity of all external links.</dd>
<dt><strong>xml</strong></dt>
<dd>Build Docutils-native XML files.</dd>
<dt><strong>pseudoxml</strong></dt>
<dd>Build compact pretty-printed “pseudo-XML” files displaying the
internal structure of the intermediate document trees.</dd>
</dl>
<p>See <a class="reference internal" href="builders.html#builders"><span class="std std-ref">Available builders</span></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">
<code class="descname">-a</code><code class="descclassname"></code><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">
<code class="descname">-E</code><code class="descclassname"></code><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"><span class="xref std std-term">environment</span></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">
<code class="descname">-t</code><code class="descclassname"> tag</code><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"><code class="xref rst rst-dir docutils literal"><span class="pre">only</span></code></a> directives that
only include their content if this tag is set.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.6.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-d">
<code class="descname">-d</code><code class="descclassname"> path</code><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 <code class="file docutils literal"><span class="pre">.doctrees</span></code> 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-j">
<code class="descname">-j</code><code class="descclassname"> N</code><a class="headerlink" href="#cmdoption-sphinx-build-j" title="Permalink to this definition">¶</a></dt>
<dd><p>Distribute the build over <em>N</em> processes in parallel, to make building on
multiprocessor machines more effective.  Note that not all parts and not all
builders of Sphinx can be parallelized.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2: </span>This option should be considered <em>experimental</em>.</p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-c">
<code class="descname">-c</code><code class="descclassname"> path</code><a class="headerlink" href="#cmdoption-sphinx-build-c" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t look for the <code class="file docutils literal"><span class="pre">conf.py</span></code> 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>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.3.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="id1">
<code class="descname">-C</code><code class="descclassname"></code><a class="headerlink" href="#id1" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t look for a configuration file; only take options via the <code class="docutils literal"><span class="pre">-D</span></code> option.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.5.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="id2">
<code class="descname">-D</code><code class="descclassname"> setting=value</code><a class="headerlink" href="#id2" title="Permalink to this definition">¶</a></dt>
<dd><p>Override a configuration value set in the <code class="file docutils literal"><span class="pre">conf.py</span></code> file.  The value
must be a number, string, list or dictionary value.</p>
<p>For lists, you can separate elements with a comma like this: <code class="docutils literal"><span class="pre">-D</span>
<span class="pre">html_theme_path=path1,path2</span></code>.</p>
<p>For dictionary values, supply the setting name and key like this:
<code class="docutils literal"><span class="pre">-D</span> <span class="pre">latex_elements.docclass=scrartcl</span></code>.</p>
<p>For boolean values, use <code class="docutils literal"><span class="pre">0</span></code> or <code class="docutils literal"><span class="pre">1</span></code> as the value.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 0.6: </span>The value can now be a dictionary value.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.3: </span>The value can now also be a list value.</p>
</div>
</dd></dl>

<dl class="option">
<dt id="id3">
<code class="descname">-A</code><code class="descclassname"> name=value</code><a class="headerlink" href="#id3" title="Permalink to this definition">¶</a></dt>
<dd><p>Make the <em>name</em> assigned to <em>value</em> in the HTML templates.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.5.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-n">
<code class="descname">-n</code><code class="descclassname"></code><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.  See the config value <a class="reference internal" href="config.html#confval-nitpick_ignore"><code class="xref std std-confval docutils literal"><span class="pre">nitpick_ignore</span></code></a> for a way to
exclude some references as “known missing”.</p>
</dd></dl>

<dl class="option">
<dt id="id4">
<code class="descname">-N</code><code class="descclassname"></code><a class="headerlink" href="#id4" title="Permalink to this definition">¶</a></dt>
<dd><p>Do not emit colored output.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-v">
<code class="descname">-v</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-build-v" title="Permalink to this definition">¶</a></dt>
<dd><p>Increase verbosity (loglevel).  This option can be given up to three times
to get more debug logging output.  It implies <a class="reference internal" href="#id7"><code class="xref std std-option docutils literal"><span class="pre">-T</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-q">
<code class="descname">-q</code><code class="descclassname"></code><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="id5">
<code class="descname">-Q</code><code class="descclassname"></code><a class="headerlink" href="#id5" 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">
<code class="descname">-w</code><code class="descclassname"> file</code><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="id6">
<code class="descname">-W</code><code class="descclassname"></code><a class="headerlink" href="#id6" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn warnings into errors.  This means that the build stops at the first
warning and <code class="docutils literal"><span class="pre">sphinx-build</span></code> exits with exit status 1.</p>
</dd></dl>

<dl class="option">
<dt id="id7">
<code class="descname">-T</code><code class="descclassname"></code><a class="headerlink" href="#id7" title="Permalink to this definition">¶</a></dt>
<dd><p>Display the full traceback when an unhandled exception occurs.  Otherwise,
only a summary is displayed and the traceback information is saved to a file
for further analysis.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-p">
<code class="descname">-P</code><code class="descclassname"></code><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, <code class="xref py py-mod docutils literal"><span class="pre">pdb</span></code>, if an
unhandled exception occurs while building.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-build-h">
<code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-build-h" title="Permalink to this definition">¶</a></dt>
<dd><p>Display usage summary or Sphinx version.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.</span></p>
</div>
</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="environment-variables">
<h2>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
<p>The <strong class="program">sphinx-build</strong> refers following environment variables:</p>
<dl class="describe">
<dt>
<code class="descname">MAKE</code></dt>
<dd><p>A path to make command.  A command name is also allowed.
<strong class="program">sphinx-build</strong> uses it to invoke sub-build process on make-mode.</p>
</dd></dl>

</div>
<div class="section" id="makefile-options">
<h2>Makefile options<a class="headerlink" href="#makefile-options" title="Permalink to this headline">¶</a></h2>
<p>The <code class="file docutils literal"><span class="pre">Makefile</span></code> and <code class="file docutils literal"><span class="pre">make.bat</span></code> 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"><code class="xref std std-option docutils literal"><span class="pre">-b</span></code></a> and <a class="reference internal" href="#cmdoption-sphinx-build-d"><code class="xref std std-option docutils literal"><span class="pre">-d</span></code></a> options.  However, they support the following
variables to customize behavior:</p>
<dl class="describe">
<dt>
<code class="descname">PAPER</code></dt>
<dd><p>The value for ‘“papersize”` key of <a class="reference internal" href="config.html#confval-latex_elements"><code class="xref std std-confval docutils literal"><span class="pre">latex_elements</span></code></a>.</p>
</dd></dl>

<dl class="describe">
<dt>
<code class="descname">SPHINXBUILD</code></dt>
<dd><p>The command to use instead of <code class="docutils literal"><span class="pre">sphinx-build</span></code>.</p>
</dd></dl>

<dl class="describe">
<dt>
<code class="descname">BUILDDIR</code></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>
<code class="descname">SPHINXOPTS</code></dt>
<dd><p>Additional options for <strong class="program">sphinx-build</strong>.</p>
</dd></dl>

</div>
<div class="section" id="deprecation-warnings">
<span id="when-deprecation-warnings-are-displayed"></span><h2>Deprecation Warnings<a class="headerlink" href="#deprecation-warnings" title="Permalink to this headline">¶</a></h2>
<p>If any deprecation warning like <code class="docutils literal"><span class="pre">RemovedInSphinxXXXWarning</span></code> are displayed
when building a user’s document, some Sphinx extension is using deprecated
features. In that case, please report it to author of the extension.</p>
<p>To disable the deprecation warnings, please set <code class="docutils literal"><span class="pre">PYTHONWARNINGS=</span></code> environment
variable to your environment. For example:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">PYTHONWARNINGS=</span> <span class="pre">make</span> <span class="pre">html</span></code> (Linux/Mac)</li>
<li><code class="docutils literal"><span class="pre">export</span> <span class="pre">PYTHONWARNINGS=</span></code> and do <code class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></code> (Linux/Mac)</li>
<li><code class="docutils literal"><span class="pre">set</span> <span class="pre">PYTHONWARNINGS=</span></code> and do <code class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></code> (Windows)</li>
<li>modify your Makefile/make.bat and set the environment variable</li>
</ul>
</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-console"><div class="highlight"><pre><span></span><span class="gp">$</span> sphinx-apidoc <span class="o">[</span>options<span class="o">]</span> -o outputdir packagedir <span class="o">[</span>pathnames<span class="o">]</span>
</pre></div>
</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>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p><code class="docutils literal"><span class="pre">sphinx-apidoc</span></code> generates reST files that use <a class="reference internal" href="ext/autodoc.html#module-sphinx.ext.autodoc" title="sphinx.ext.autodoc: Include documentation from docstrings."><code class="xref py py-mod docutils literal"><span class="pre">sphinx.ext.autodoc</span></code></a> to
document all found modules.  If any modules have side effects on import,
these will be executed by <code class="docutils literal"><span class="pre">autodoc</span></code> when <code class="docutils literal"><span class="pre">sphinx-build</span></code> is run.</p>
<p class="last">If you document scripts (as opposed to library modules), make sure their main
routine is protected by a <code class="docutils literal"><span class="pre">if</span> <span class="pre">__name__</span> <span class="pre">==</span> <span class="pre">'__main__'</span></code> condition.</p>
</div>
<p>The <strong class="program">sphinx-apidoc</strong> script has several options:</p>
<dl class="option">
<dt id="cmdoption-sphinx-apidoc-o">
<code class="descname">-o</code><code class="descclassname"> outputdir</code><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">
<code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--force</code><code class="descclassname"></code><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">
<code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--dry-run</code><code class="descclassname"></code><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">
<code class="descname">-s</code><code class="descclassname"> suffix</code><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 <code class="docutils literal"><span class="pre">rst</span></code>.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-d">
<code class="descname">-d</code><code class="descclassname"> maxdepth</code><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-l">
<code class="descname">-l</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--follow-links</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-apidoc-l" title="Permalink to this definition">¶</a></dt>
<dd><p>This option makes sphinx-apidoc follow symbolic links when recursing the
filesystem to discover packages and modules. You may need it if you want
to generate documentation from a source directory managed by
<a class="reference external" href="https://pypi.python.org/pypi/collective.recipe.omelette/">collective.recipe.omelette</a>.
By default, symbolic links are skipped.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.</span></p>
</div>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-t">
<code class="descname">-T</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--no-toc</code><code class="descclassname"></code><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 <code class="docutils literal"><span class="pre">modules.rst</span></code>.
This has no effect when <a class="reference internal" href="#cmdoption-sphinx-apidoc-full"><code class="xref std std-option docutils literal"><span class="pre">--full</span></code></a> is given.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-full">
<code class="descname">-F</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--full</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-apidoc-full" 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-implicit-namespaces">
<code class="descname">--implicit-namespaces</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-apidoc-implicit-namespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>By default sphinx-apidoc processes sys.path searching for modules only.
Python 3.3 introduced <span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0420"><strong>PEP 420</strong></a> implicit namespaces that allow module path
structures such as <code class="docutils literal"><span class="pre">foo/bar/module.py</span></code> or <code class="docutils literal"><span class="pre">foo/bar/baz/__init__.py</span></code>
(notice that <code class="docutils literal"><span class="pre">bar</span></code> and <code class="docutils literal"><span class="pre">foo</span></code> are namespaces, not modules).</p>
<p>Specifying this option interprets paths recursively according to PEP-0420.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-m">
<code class="descname">-M</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-apidoc-m" title="Permalink to this definition">¶</a></dt>
<dd><p>This option makes sphinx-apidoc put module documentation before submodule
documentation.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-a">
<code class="descname">-a</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-sphinx-apidoc-a" title="Permalink to this definition">¶</a></dt>
<dd><p>Append module_path to sys.path.</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-h">
<code class="descname">-H</code><code class="descclassname"> project</code><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="setuptools.html#confval-project"><code class="xref std std-confval docutils literal"><span class="pre">project</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="id8">
<code class="descname">-A</code><code class="descclassname"> author</code><a class="headerlink" href="#id8" 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="setuptools.html#confval-copyright"><code class="xref std std-confval docutils literal"><span class="pre">copyright</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-v">
<code class="descname">-V</code><code class="descclassname"> version</code><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="setuptools.html#confval-version"><code class="xref std std-confval docutils literal"><span class="pre">version</span></code></a>).</p>
</dd></dl>

<dl class="option">
<dt id="cmdoption-sphinx-apidoc-r">
<code class="descname">-R</code><code class="descclassname"> release</code><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="setuptools.html#confval-release"><code class="xref std std-confval docutils literal"><span class="pre">release</span></code></a>).</p>
</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="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>&#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 / invocation.html
