summaryrefslogtreecommitdiffstats
path: root/development/Sphinx/README
blob: da622c8650a6051f7b04ef8bddef2ae483a71431 (plain)
1
2
3
4
5
6
7
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.