diff options
Diffstat (limited to 'make-doc')
-rwxr-xr-x | make-doc | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/make-doc b/make-doc new file mode 100755 index 000000000..a4ee095b6 --- /dev/null +++ b/make-doc @@ -0,0 +1,29 @@ +#!/bin/bash + +# Hackish script to generate documentation using epydoc + +sources="ipalib ipa_server ipa_webui tests" +out="./freeipa2-dev-doc" + +init="./ipalib/__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 $out ]] +then + echo "Removing old $out directory" + rm -r $out +fi +echo "Creating documentation in $out" + +epydoc -v --html --no-frames --include-log \ + --name="FreeIPA v2 developer documentation" \ + --docformat=restructuredtext \ + --output=$out \ + $sources |