diff options
Diffstat (limited to 'development/epydoc/README')
| -rw-r--r-- | development/epydoc/README | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/development/epydoc/README b/development/epydoc/README new file mode 100644 index 0000000000000..22bc8650bf41c --- /dev/null +++ b/development/epydoc/README @@ -0,0 +1,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. |