scripts/build_epydocs.sh
author Daniel Hans <Daniel.M.Hans@gmail.com>
Mon, 17 Aug 2009 18:43:23 +0200
changeset 2779 db04432cb99a
parent 130 63248d9db484
permissions -rwxr-xr-x
Argument to_json added to json function in Base view. Its value (which should be a boolean) determines if the data should be converted to a JSON object. Therefore if someone has already a JSON string and wants to return it in a HTTP response, he or she may set to_json=False and the object will not be converted.

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