scripts/build_epydocs.sh
author Pawel Solyga <Pawel.Solyga@gmail.com>
Tue, 20 Jan 2009 21:00:55 +0000
changeset 848 07fd6a603c24
parent 130 63248d9db484
permissions -rwxr-xr-x
Disable R0801 messages in pylintrc. R0801 messages indicates that a set of similar lines has been detected among multiple file. This usually means that the code should be refactored to avoid this duplication but in our case it's useless since it shows a lot of imports code or authors. 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."