[Python-checkins] r61511 - doctools/trunk/doc/intro.rst

georg.brandl python-checkins at python.org
Tue Mar 18 08:39:40 CET 2008


Author: georg.brandl
Date: Tue Mar 18 08:39:40 2008
New Revision: 61511

Modified:
   doctools/trunk/doc/intro.rst
Log:
Add a para about sphinx <-> epydoc.


Modified: doctools/trunk/doc/intro.rst
==============================================================================
--- doctools/trunk/doc/intro.rst	(original)
+++ doctools/trunk/doc/intro.rst	Tue Mar 18 08:39:40 2008
@@ -5,6 +5,11 @@
 tool that translates a set of reStructuredText_ source files into various output
 formats, automatically producing cross-references, indices etc.
 
+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