scripts/build_epydocs.sh
author Sverre Rabbelier <srabbelier@gmail.com>
Tue, 22 Sep 2009 13:07:27 +0200
changeset 2968 7ba28890eb75
parent 130 63248d9db484
permissions -rwxr-xr-x
Prevent modification of key fields Only non-id-based entities are affected as id-based entities do not have any un-modificable fields.

#!/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."