aboutsummaryrefslogtreecommitdiff
path: root/development/epydoc/README
blob: 22bc8650bf41cf5dea7cc42492391b09f62cff1c (plain)
1
2
3
4
5
6
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.