diff options
| author | georg.brandl <devnull@localhost> | 2008-03-18 07:39:40 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-03-18 07:39:40 +0000 |
| commit | 238c8817872a3ca0fa684c494b7463e6f98b3697 (patch) | |
| tree | a2984d0698938cb9dc1ac242272b77a2a62bf75d /doc/intro.rst | |
| parent | bfe7a1bfd4e3f1a19b46b5b98d9f4bd3cbb88ef0 (diff) | |
| download | sphinx-238c8817872a3ca0fa684c494b7463e6f98b3697.tar.gz | |
Add a para about sphinx <-> epydoc.
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index 19b65bae..31c3d6f0 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -5,6 +5,11 @@ 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. +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 |
