scripts/build_epydocs.sh
author Pawel Solyga <Pawel.Solyga@gmail.com>
Wed, 04 Mar 2009 17:24:19 +0000
changeset 1626 fe455c93cbf6
parent 130 63248d9db484
permissions -rwxr-xr-x
Remove unused imports, add missing blank lines, fix too long lines, fix docstring parameters to match the ones in method declaration, rename to short variable names in soc.logic.models.base module. Patch by: Pawel Solyga Reviewed 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."