diff options
Diffstat (limited to 'development/Sphinx/README')
| -rw-r--r-- | development/Sphinx/README | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/development/Sphinx/README b/development/Sphinx/README index da622c8650..e5644a5a0e 100644 --- a/development/Sphinx/README +++ b/development/Sphinx/README @@ -1,7 +1,4 @@ -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. +Sphinx is a tool that translates a set of reStructuredText source files into +various output formats, including HTML, ePub, LaTeX and plain text. Sphinx was +originally created for the Python documentation, but it has excellent +facilities for the documentation of software projects in a range of languages. |