diff options
Diffstat (limited to 'development/epydoc')
| -rw-r--r-- | development/epydoc/README | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/development/epydoc/README b/development/epydoc/README index 22bc8650bf41c..3ccc56eea2114 100644 --- a/development/epydoc/README +++ b/development/epydoc/README @@ -1,6 +1,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. +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. |