scripts/build_epydocs.sh
author Lennard de Rijk <ljvderijk@gmail.com>
Tue, 05 May 2009 21:48:46 +0200
changeset 2296 ebc4931f0762
parent 130 63248d9db484
permissions -rwxr-xr-x
Fixed typo in docstring as to comments on r3012 (svn repo). Also now importing logic and using keyword arguments as to comply with the codebase standards Patch by: Lennard de Rijk 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."