sphinx / doc / intro.rst

georg.brandl 186cf92 


georg.brandl b3fff67 

georg.brandl 72370f1 




Georg Brandl cec7b81 

georg.brandl 186cf92 
georg.brandl f6b03bc 
Georg Brandl 86e7ddb 


georg.brandl f6b03bc 
georg.brandl a895655 







Georg Brandl eb9cb40 

georg.brandl a895655 



georg.brandl e5cf123 
georg.brandl a895655 
Georg Brandl fd56ff4 


georg.brandl a895655 
Georg Brandl ca1aea7 





georg.brandl 186cf92 


Georg Brandl a2feb99 



georg.brandl b3fff67 

Georg Brandl a2feb99 


georg.brandl b3fff67 

Georg Brandl ca1aea7 

georg.brandl b3fff67 
Georg Brandl 816796d 
Introduction
============

This is the documentation for the Sphinx documentation builder.  Sphinx is a
tool that translates a set of reStructuredText_ 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 `rst2pdf <http://rst2pdf.googlecode.com>`_.

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 `Epydoc <http://epydoc.sf.net/>`_, which also understands reST.


Conversion from other systems
-----------------------------

This section is intended to collect helpful hints for those wanting to migrate
to reStructuredText/Sphinx from other documentation systems.

* Gerard Flanagan has written a script to convert pure HTML to reST; it can be
  found at `BitBucket
  <http://bitbucket.org/djerdo/musette/src/tip/musette/html/html2rest.py>`_.

* For converting the old Python docs to Sphinx, a converter was written which
  can be found at `the Python SVN repository
  <http://svn.python.org/projects/doctools/converter>`_.  It contains generic
  code to convert Python-doc-style LaTeX markup to Sphinx reST.

* Marcin Wojdyr has written a script to convert Docbook to reST with Sphinx
  markup; it is at `Google Code <http://code.google.com/p/db2rst/>`_.


Use with other systems
----------------------

See the :ref:`pertinent section in the FAQ list <usingwith>`.


Prerequisites
-------------

Sphinx needs at least **Python 2.4** to run, as well as the docutils_ and
Jinja2_ 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 Pygments_ library.

.. _reStructuredText: http://docutils.sf.net/rst.html
.. _docutils: http://docutils.sf.net/
.. _Jinja2: http://jinja.pocoo.org/2/
.. _Pygments: http://pygments.org/


Usage
-----

See :doc:`tutorial` for an introduction.  It also contains links to more
advanced sections in this manual for the topics it discusses.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.