scripts/build_epydocs.sh
author Todd Larsen <tlarsen@google.com>
Fri, 26 Sep 2008 19:47:07 +0000
changeset 204 7075c27170f2
parent 130 63248d9db484
permissions -rwxr-xr-x
Add ModelWithFieldAttributes *before* PolyModel, so that everything does not become a "ModelWithFieldAttributes" in the Datastore. The way PolyModel works, each Model class hierarchy is stored in the Datastore as the class that directly inherited from PolyModel. So, we do not want to insert ModelWithFieldAttributes *after* PolyModel by inheriting *from* PolyModel, or everything would just be a ModelWithFieldAttributes in the Datastore, instead of Person, Work, Group, etc.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     1
#!/bin/bash
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     2
# Generates epydoc for $target to $outdir, while ignoring $exclude
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     3
# WARNING: The contents of $outdir are -deleted- before the running epydoc
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     4
# This way there are no 'stale files' when the script finishes.
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     5
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     6
 outdir="../../wiki/html/epydoc"
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     7
 target="../app ../tests"
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     8
exclude="django"
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
     9
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    10
echo "Cleaning out $outdir..."
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    11
rm -f $outdir/*
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    12
echo "Done."
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    13
echo
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    14
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    15
echo "Running epydoc..."
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    16
echo "$target -> $outdir"
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    17
echo "================="
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    18
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    19
epydoc --html -v --show-private --inheritance=included --graph=all \
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    20
  --parse-only --exclude=$exclude -o $outdir $target
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    21
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    22
echo "================="
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    23
echo "Done."
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    24
echo
10
56109601507d Script to generate epydoc documents in wiki/html/epydoc.
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    25
130
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    26
echo "Goodbye."
63248d9db484 Updated the script to:
Sverre Rabbelier <srabbelier@gmail.com>
parents: 10
diff changeset
    27