<!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>Introduction — Sphinx v1.0.7 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.0.7',
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 v1.0.7 documentation"
href="_static/opensearch.xml"/>
<link rel="top" title="Sphinx v1.0.7 documentation" href="index.html" />
<link rel="next" title="First Steps with Sphinx" href="tutorial.html" />
<link rel="prev" title="Sphinx documentation contents" href="contents.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="tutorial.html" title="First Steps with Sphinx"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="contents.html" title="Sphinx documentation contents"
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="#">Introduction</a><ul>
<li><a class="reference internal" href="#conversion-from-other-systems">Conversion from other systems</a></li>
<li><a class="reference internal" href="#use-with-other-systems">Use with other systems</a></li>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="contents.html"
title="previous chapter">Sphinx documentation contents</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="tutorial.html"
title="next chapter">First Steps with Sphinx</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/intro.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" size="18" />
<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="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p>This is the documentation for the Sphinx documentation builder. Sphinx is a
tool that translates a set of <a class="reference external" href="http://docutils.sf.net/rst.html">reStructuredText</a> source files into various output
formats, automatically producing cross-references, indices etc. That is, if
you have a directory containing a bunch of reST-formatted documents (and
possibly subdirectories of docs in there as well), Sphinx can generate a
nicely-organized arrangement of HTML files (in some other directory) for easy
browsing and navigation. But from the same source, it can also generate a
LaTeX file that you can compile into a PDF version of the documents, or a
PDF file directly using <a class="reference external" href="http://rst2pdf.googlecode.com">rst2pdf</a>.</p>
<p>The focus is on hand-written documentation, rather than auto-generated API docs.
Though there is support for that kind of docs as well (which is intended to be
freely mixed with hand-written content), if you need pure API docs have a look
at <a class="reference external" href="http://epydoc.sf.net/">Epydoc</a>, which also understands reST.</p>
<div class="section" id="conversion-from-other-systems">
<h2>Conversion from other systems<a class="headerlink" href="#conversion-from-other-systems" title="Permalink to this headline">¶</a></h2>
<p>This section is intended to collect helpful hints for those wanting to migrate
to reStructuredText/Sphinx from other documentation systems.</p>
<ul class="simple">
<li>Gerard Flanagan has written a script to convert pure HTML to reST; it can be
found at <a class="reference external" href="http://bitbucket.org/djerdo/musette/src/tip/musette/html/html2rest.py">BitBucket</a>.</li>
<li>For converting the old Python docs to Sphinx, a converter was written which
can be found at <a class="reference external" href="http://svn.python.org/projects/doctools/converter">the Python SVN repository</a>. It contains generic
code to convert Python-doc-style LaTeX markup to Sphinx reST.</li>
<li>Marcin Wojdyr has written a script to convert Docbook to reST with Sphinx
markup; it is at <a class="reference external" href="http://code.google.com/p/db2rst/">Google Code</a>.</li>
</ul>
</div>
<div class="section" id="use-with-other-systems">
<h2>Use with other systems<a class="headerlink" href="#use-with-other-systems" title="Permalink to this headline">¶</a></h2>
<p>See the <a class="reference internal" href="faq.html#usingwith"><em>pertinent section in the FAQ list</em></a>.</p>
</div>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<p>Sphinx needs at least <strong>Python 2.4</strong> to run, as well as the <a class="reference external" href="http://docutils.sf.net/">docutils</a> and
<a class="reference external" href="http://jinja.pocoo.org/2/">Jinja2</a> libraries. Sphinx should work with docutils version 0.5 or some
(not broken) SVN trunk snapshot. If you like to have source code highlighting
support, you must also install the <a class="reference external" href="http://pygments.org/">Pygments</a> library.</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>See <a class="reference internal" href="tutorial.html"><em>First Steps with Sphinx</em></a> for an introduction. It also contains links to more
advanced sections in this manual for the topics it discusses.</p>
</div>
</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="tutorial.html" title="First Steps with Sphinx"
>next</a> |</li>
<li class="right" >
<a href="contents.html" title="Sphinx documentation contents"
>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.0.7.
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
2b39e69e45f9a0b2b3aece7339c56216
>
files
>
101
