aboutsummaryrefslogtreecommitdiff
path: root/development/Sphinx/README
blob: c5fdb45b62127b5b6a2d6014365128db7f975d6f (plain)
1
2
3
4
5
6
7
8
9
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
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, which also understands reST.

Pygments is an optional runtime-only dependency.