[Python-checkins] r65640 - doctools/branches/0.4.x/doc/intro.rst

georg.brandl python-checkins at python.org
Mon Aug 11 16:11:17 CEST 2008


Author: georg.brandl
Date: Mon Aug 11 16:11:17 2008
New Revision: 65640

Log:
More info in intro.


Modified:
   doctools/branches/0.4.x/doc/intro.rst

Modified: doctools/branches/0.4.x/doc/intro.rst
==============================================================================
--- doctools/branches/0.4.x/doc/intro.rst	(original)
+++ doctools/branches/0.4.x/doc/intro.rst	Mon Aug 11 16:11:17 2008
@@ -3,15 +3,18 @@
 
 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.
+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.
 
 The focus is on hand-written documentation, rather than auto-generated API docs.
 Though there is limited 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.
 
-.. XXX web app
-
 Prerequisites
 -------------
 


More information about the Python-checkins mailing list