summaryrefslogtreecommitdiff
path: root/development/epydoc/README
diff options
context:
space:
mode:
authorAndrew Psaltis <ampsaltis@gmail.com>2010-05-12 23:28:39 +0200
committerDavid Somero <xgizzmo@slackbuilds.org>2010-05-12 23:28:39 +0200
commitac47f75883b16016bfecfcc3f323cce8b0e52586 (patch)
tree9a982344824585cb599b062258921f5e5d68d3d3 /development/epydoc/README
parent58246cdcc22d9395e5d3bfae186b8112fe892900 (diff)
downloadslackbuilds-ac47f75883b16016bfecfcc3f323cce8b0e52586.tar.gz
development/epydoc: Added to 12.2 repository
Diffstat (limited to 'development/epydoc/README')
-rw-r--r--development/epydoc/README6
1 files changed, 6 insertions, 0 deletions
diff --git a/development/epydoc/README b/development/epydoc/README
new file mode 100644
index 0000000000..22bc8650bf
--- /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.