mirror of
https://github.com/Ponce/slackbuilds
synced 2024-11-06 08:26:50 +01:00
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:
parent
c61c83f0c5
commit
e249b74d9d
1 changed files with 6 additions and 5 deletions
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue