scripts/build_epydocs.sh
author Sverre Rabbelier <srabbelier@gmail.com>
Wed, 02 Sep 2009 10:24:10 +0200
changeset 2854 003a84e774e2
parent 130 63248d9db484
permissions -rwxr-xr-x
Add support for prefetching fields This makes it possible to specify the fields that should be prefetched as part of a getForFields query. Doing a prefetch on a ReferenceProperty when it is known that the property will be referenced in (almost all) entities is far more efficient than doing the invididual fetches sequentially.

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