Skip to content

Commit 633c397

Browse files
Documentation: generate the API documentation
We use epydoc to generate the API documentation.
1 parent 867f568 commit 633c397

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

epydoc/build-api.sh

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
DIR=/tmp
6+
VERSION=$(pyversions -i)
7+
export PYTHON=python
8+
9+
pushd $(dirname $0)/..
10+
11+
# build from source
12+
make clean
13+
make build
14+
15+
# install in /tmp
16+
PYTHONPATH=$DIR/lib/$VERSION/site-packages
17+
echo $PYTHONPATH
18+
mkdir -p $PYTHONPATH
19+
export PYTHONPATH
20+
21+
$PYTHON setup.py install --prefix=$DIR
22+
23+
popd
24+
25+
# generate doc
26+
mkdir -p generated/epydoc
27+
epydoc --verbose --html --output generated/epydoc --config=epydoc.cfg
28+
File renamed without changes.

epydoc/sync.sh

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
# update the web site at sourceforge.net
6+
pushd $(dirname $0)/generated
7+
rsync --recursive --verbose --update epydoc [email protected]:/home/project-web/pyscard/htdocs/
8+
popd

0 commit comments

Comments
 (0)