wxPython/docs/bin/makeapidocs

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