summaryrefslogtreecommitdiffstats
path: root/gen-doc.bash
blob: ba77547c51caf424e59bc005fbac0ed7b2d3bda1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
#!/bin/bash

# Hackish script to generate documentation using epydoc

mod="ipalib"
d="./$mod-doc"
f="$d.tar.bz2"

init="./$mod/__init__.py"
echo "Looking for $init"
if [[ ! -f $init ]]
then
    echo "Error: You do not appear to be in the project directory"
    exit 1
fi
echo "You appear to be in the project directory"

# Documentation
if [[ -d $d ]]
then
    echo "Removing old $d directory"
    rm -r $d
fi
echo "Creating documentation in $d"
epydoc -v --output=$d --docformat=restructuredtext --html --no-frames $mod

# Tarball
if [[ -f $f ]]
then
    echo "Removing old $f file"
    rm $f
fi
echo "Creating tarball $f"
tar --create --bzip2 --file=$f $d