freeipa/make-doc

30 lines
646 B
Plaintext
Raw Normal View History

2008-08-14 14:57:15 -05:00
#!/bin/bash
# Hackish script to generate documentation using epydoc
sources="ipalib ipa_server ipa_webui tests"
out="./freeipa2-dev-doc"
2008-08-14 14:57:15 -05:00
init="./ipalib/__init__.py"
2008-08-14 14:57:15 -05:00
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 $out ]]
2008-08-14 14:57:15 -05:00
then
echo "Removing old $out directory"
rm -r $out
2008-08-14 14:57:15 -05:00
fi
echo "Creating documentation in $out"
2008-10-07 16:26:50 -05:00
2008-10-07 22:44:34 -05:00
epydoc -v --html --no-frames --include-log \
2008-10-07 23:20:00 -05:00
--name="FreeIPA v2 developer documentation" \
--docformat=restructuredtext \
--output=$out \
$sources