scripts/build_epydocs.sh
author Daniel Bentley <dbentley@google.com>
Sun, 12 Apr 2009 09:06:45 +0000
branchgae-fetch-limitation-fix
changeset 2313 c39a81bce1bd
parent 130 63248d9db484
permissions -rwxr-xr-x
Use offset_linkid instead of offset to scan >1000 entities. this is a first-cut. It works in all the ways I could make earlier versions fail. It passes link_id as URL parameters. It also has a new class LinkCreator which makes the main body of getListContents even easier to write. I wasn't sure if link_id's could have non alphanumeric characters; if so, they need to be URL encoded/decoded. I also need to go and remove any mention of raw offsets now, because we don't use them. I believe I've talked about this approach with a few of you and it sounded reasonable. Feel free to roll-back/fix/amend/comment-for-me-to-fix. This is my first big-logic-change to Melange. Patch by: Dan Bentley
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