Personal tools

Epydoc

We use Epydoc for building the API documentation of Biskit.
  1. Install Graphviz package:

    cd /usr/local/src
    wget http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.12.tar.gz
    tar xvfz graphviz*.tar.gz
    cd graphviz-*/
    ./configure --prefix=/usr/local
    make
    make install
    

    Troubleshooting:

    If compilation failes with "cannot find -lpython2.5", try this:

    export LDFLAGS="-L/usr/local/lib/python2.5/config -L."
    make clean
    ./configure --prefix=/usr/local; make; make install
    

    Note:

    For Ubuntu, graphviz is available as package graphviz and graphviz-dev.

  2. Fetch Epydoc:

    cd /usr/local/src
    sudo wget http://downloads.sourceforge.net/epydoc/epydoc-3.0beta1.tar.gz
    sudo tar xvfz epydoc*
    sudo rm epydoc*tar.gz
    

    Note:

    For Ubuntu, epydoc 2.1 is available as package python-epydoc .

  3. Compile and install epydoc:

    cd epydoc*
    sudo python setup.py install