diff options
Diffstat (limited to 'development/epydoc')
-rw-r--r-- | development/epydoc/README | 6 | ||||
-rw-r--r-- | development/epydoc/epydoc.SlackBuild | 72 | ||||
-rw-r--r-- | development/epydoc/epydoc.info | 8 | ||||
-rw-r--r-- | development/epydoc/slack-desc | 20 |
4 files changed, 106 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. diff --git a/development/epydoc/epydoc.SlackBuild b/development/epydoc/epydoc.SlackBuild new file mode 100644 index 0000000000..78f28930e3 --- /dev/null +++ b/development/epydoc/epydoc.SlackBuild @@ -0,0 +1,72 @@ +#!/bin/sh + +# Slackware build script for epydoc + +# Copyright 2009 Andrew Psaltis <ampsaltis@gmail.com> +# All rights reserved. +# Redistribution and use of this script, with or without modification, is +# permitted provided that the following conditions are met: +# +# 1. Redistributions of this script must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED +# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +# EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; +# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR +# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +PRGNAM=epydoc +VERSION=3.0.1 +ARCH=${ARCH:-noarch} +BUILD=${BUILD:-1} +TAG=${TAG:-_SBo} + +CWD=$(pwd) +TMP=${TMP:-/tmp/SBo} +PKG=$TMP/package-$PRGNAM +OUTPUT=${OUTPUT:-/tmp} + +DOCS="LICENSE.txt README.txt" + +set -e + +rm -rf $PKG +mkdir -p $TMP $PKG $OUTPUT +cd $TMP +rm -rf $PRGNAM-$VERSION +tar xfvz $CWD/$PRGNAM-$VERSION.tar.gz +cd $PRGNAM-$VERSION +chown -R root:root . +find . \ + \( -perm 777 -o -perm 775 -o -perm 711 -o -perm 555 -o -perm 511 \) \ + -exec chmod 755 {} \; -o \ + \( -perm 666 -o -perm 664 -o -perm 600 -o -perm 444 -o -perm 440 -o -perm 400 \) \ + -exec chmod 644 {} \; + +python setup.py install --root=$PKG + +# Placate the silly build system. +mkdir -p $PKG/usr/doc +mkdir -p $PKG/usr/man/man1 +make LIB=$PKG/usr installdocs + +mv $PKG/usr/doc/$PRGNAM $PKG/usr/doc/$PRGNAM-$VERSION +cp -a $DOCS $PKG/usr/doc/$PRGNAM-$VERSION +cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild + +( cd $PKG/usr/man + find . -type f -exec gzip -9 {} \; + for i in $( find . -type l ) ; do ln -s $( readlink $i ).gz $i.gz ; rm $i ; done +) + +mkdir -p $PKG/install +cat $CWD/slack-desc > $PKG/install/slack-desc + +cd $PKG +/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.tgz diff --git a/development/epydoc/epydoc.info b/development/epydoc/epydoc.info new file mode 100644 index 0000000000..e1e75811f2 --- /dev/null +++ b/development/epydoc/epydoc.info @@ -0,0 +1,8 @@ +PRGNAM="epydoc" +VERSION="3.0.1" +HOMEPAGE="http://epydoc.sourceforge.net/" +DOWNLOAD="http://dl.sourceforge.net/sourceforge/epydoc/epydoc-3.0.1.tar.gz" +MD5SUM="cdd6f6c76dd8bab5e653a343a0544294" +MAINTAINER="Andrew Psaltis" +EMAIL="ampsaltis@gmail.com" +APPROVED="dsomero" 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 + |