wxPython/docs/bin/makeapidocs

   1 #!/bin/bash
   2
   3 #----------------------------------------------------------------------
   4
   5 if [ ! -d wxPython ]; then  # TODO: make this test more robust
   6     echo "Please run this script from the root wxPython directory."
   7     exit 1
   8 fi
   9
  10 VERSION=`python -c "import setup;print setup.VERSION"`
  11
  12
  13 # cleanup old build
  14 rm -r docs/api/*
  15
  16 # build the docs
  17 export PTYHONPATH=$PWD
  18 epydoc --name wxPython \
  19     --html \
  20     --output docs/api \
  21     --ignore-param-mismatch \
  22     --inheritance none \
  23     --no-expand-subpackages \
  24     --no-private \
  25     --css docs/wxPython-epydoc.css \
  26     --docformat restructuredtext \
  27     --url http://wxPython.org/ \
  28     --no-frames \
  29     $* \
  30     wx
  31
  32 #    wx/__init__.py \
  33
  34 #    wx/calendar.py wx/grid.py wx/html.py wx/wizard.py \
  35 #    wx/gizmos.py wx/ogl.py wx/stc.py wx/xrc.py
  36
  37
  38 #    --no-frames \
  39 #    --docformat epytext \
  40 #    --debug \
  41 #    --inheritance grouped \
  42
  43
  44 # TODO:
  45 #   1. Should rebuild the top-level docs too (but we need more of them first!)
  46
  47
  48
  49 # bundle it all up into a tarball
  50 DEST=wxPython-$VERSION/docs
  51 mkdir -p _build_docs/$DEST
  52 cp -R --link docs/api _build_docs/$DEST
  53 cd _build_docs
  54 rm -f ../dist/wxPython-newdocs-$VERSION.tar.gz
  55 tar cf ../dist/wxPython-newdocs-$VERSION.tar $DEST
  56 gzip -9 ../dist/wxPython-newdocs-$VERSION.tar
  57
  58 # Cleanup
  59 cd ..
  60 rm -r _build_docs
  61