scripts/build_epydocs.sh
author Pawel Solyga <Pawel.Solyga@gmail.com>
Tue, 20 Jan 2009 16:03:55 +0000
changeset 833 1b9604b95eeb
parent 130 63248d9db484
permissions -rwxr-xr-x
Disable R0201 message in pylintrc since we allow for that kind of methods. R0201 tells us that method could be a function. Used when a method doesn't use its bound instance, and so could be written as a function. Patch by: Pawel Solyga Review by: to-be-reviewed

#!/bin/bash
# Generates epydoc for $target to $outdir, while ignoring $exclude
# WARNING: The contents of $outdir are -deleted- before the running epydoc
# This way there are no 'stale files' when the script finishes.

 outdir="../../wiki/html/epydoc"
 target="../app ../tests"
exclude="django"

echo "Cleaning out $outdir..."
rm -f $outdir/*
echo "Done."
echo

echo "Running epydoc..."
echo "$target -> $outdir"
echo "================="

epydoc --html -v --show-private --inheritance=included --graph=all \
  --parse-only --exclude=$exclude -o $outdir $target

echo "================="
echo "Done."
echo

echo "Goodbye."