Anonymous committed f6b03bc

Add a para about sphinx <-> epydoc.

Comments (0)

Files changed (1)

 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 <>`, which also understands reST.
 .. XXX web app
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.