scripts/build_epydocs.sh
author Sverre Rabbelier <srabbelier@gmail.com>
Wed, 05 Nov 2008 23:36:28 +0000
changeset 445 31927f21970d
parent 130 63248d9db484
permissions -rwxr-xr-x
Major site restructuring, also deleting of many unused or obsolete documents The new structure is as follows: <entity>/list - list all <entitie>s <entity>/create - create a new <entity> <entity>/show/<key fields> - public page for <entity> <entity>/edit/<key fields> - edit a <entity> <entity>/delete/key fields> - delete a specific entity

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