diff options
| author | B. Watson <yalhcru@gmail.com> | 2020-10-12 21:08:44 -0400 |
|---|---|---|
| committer | Willy Sudiarto Raharjo <willysr@slackbuilds.org> | 2020-10-17 09:39:04 +0700 |
| commit | e249b74d9d75800abef2b067cb0ee77aa91d3920 (patch) | |
| tree | 84051c8ad5c310feeecc07d03ea566a569289996 /development/epydoc | |
| parent | c61c83f0c515c86e10dc933104e3a3b538a791f6 (diff) | |
development/epydoc: Fix README.
Signed-off-by: B. Watson <yalhcru@gmail.com>
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
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 22bc8650bf41..3ccc56eea211 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. |