development/epydoc: Fix README.

Signed-off-by: B. Watson <yalhcru@gmail.com>

Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
This commit is contained in:
B. Watson 2020-10-12 21:08:44 -04:00 committed by Willy Sudiarto Raharjo
parent c61c83f0c5
commit e249b74d9d
No known key found for this signature in database
GPG key ID: 3F617144D7238786

View file

@ -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.