scripts/build_epydocs.sh
author Todd Larsen <tlarsen@google.com>
Fri, 03 Oct 2008 07:03:11 +0000
changeset 264 97b60788cb9a
parent 130 63248d9db484
permissions -rwxr-xr-x
Change to imports to follow the style guide: http://code.google.com/p/soc/wiki/PythonStyleGuide#Module_and_package_imports Specifically: "Use from x import y only when x is a package and y is a module."

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