summaryrefslogtreecommitdiffstats
path: root/make-doc
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-10-07 22:45:32 -0600
committerJason Gerard DeRose <jderose@redhat.com>2008-10-07 22:45:32 -0600
commit6489e4f3480e934893c5c18d1f6c34fd96f46479 (patch)
tree915e46615a8c31410fd2d15d5f22c371de8a3c4d /make-doc
parentfec6fc2e8c373c698966816ee97fe3a660eb503e (diff)
downloadfreeipa-6489e4f3480e934893c5c18d1f6c34fd96f46479.tar.gz
freeipa-6489e4f3480e934893c5c18d1f6c34fd96f46479.tar.xz
freeipa-6489e4f3480e934893c5c18d1f6c34fd96f46479.zip
Renamed gen-doc.bash, run-tests.bash to make-doc, make-test respectively
Diffstat (limited to 'make-doc')
-rwxr-xr-xmake-doc29
1 files changed, 29 insertions, 0 deletions
diff --git a/make-doc b/make-doc
new file mode 100755
index 00000000..a4ee095b
--- /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