diff options
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index 3100ae97a..69d49d94f 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -3,15 +3,18 @@ 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. +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 ------------- |