summaryrefslogtreecommitdiff
path: root/development/epydoc/slack-desc
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/slack-desc
parent58246cdcc22d9395e5d3bfae186b8112fe892900 (diff)
downloadslackbuilds-ac47f75883b16016bfecfcc3f323cce8b0e52586.tar.gz
development/epydoc: Added to 12.2 repository
Diffstat (limited to 'development/epydoc/slack-desc')
-rw-r--r--development/epydoc/slack-desc20
1 files changed, 20 insertions, 0 deletions
diff --git a/development/epydoc/slack-desc b/development/epydoc/slack-desc
new file mode 100644
index 0000000000..928224f42b
--- /dev/null
+++ b/development/epydoc/slack-desc
@@ -0,0 +1,20 @@
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description. Line
+# up the first '|' above the ':' following the base package name, and the '|' on
+# the right side marks the last column you can put a character in. You must make
+# exactly 11 lines for the formatting to be correct. It's also customary to
+# leave one space after the ':'.
+
+ |-----handy-ruler------------------------------------------------------|
+epydoc: epydoc (python api documentation tool)
+epydoc:
+epydoc: Epydoc is a tool for generating API documentation for Python modules,
+epydoc: based on their docstrings. For an example of epydoc's output, see
+epydoc: the API documentation for epydoc itself (html, pdf). A lightweight
+epydoc: markup language called epytext can be used to format docstrings,
+epydoc: and to add information about specific fields, such as parameters and
+epydoc: instance variables. Epydoc also understands docstrings written in
+epydoc: reStructuredText, Javadoc, and plaintext.
+epydoc:
+epydoc: Home page: http://epydoc.sf.net
+