summaryrefslogtreecommitdiff
path: root/development/epydoc/README
blob: 3ccc56eea211448224043ca902c0597efd4ef98f (plain)
1
2
3
4
5
6
7
Epydoc is a tool for generating API documentation for Python modules,
based on their docstrings. For an example of epydoc's output, see
the API documentation for epydoc itself (html, pdf). A lightweight
markup language called epytext can be used to format docstrings,
and to add information about specific fields, such as parameters and
instance variables. Epydoc also understands docstrings written in
reStructuredText, Javadoc, and plaintext.