summaryrefslogtreecommitdiffstats
path: root/superkaramba/doc/python_api
diff options
context:
space:
mode:
Diffstat (limited to 'superkaramba/doc/python_api')
-rw-r--r--superkaramba/doc/python_api/api.css40
-rw-r--r--superkaramba/doc/python_api/api_html.rc36
-rwxr-xr-xsuperkaramba/doc/python_api/make_api_doc.sh42
3 files changed, 118 insertions, 0 deletions
diff --git a/superkaramba/doc/python_api/api.css b/superkaramba/doc/python_api/api.css
new file mode 100644
index 0000000..d788da0
--- /dev/null
+++ b/superkaramba/doc/python_api/api.css
@@ -0,0 +1,40 @@
+body
+{
+ background-color: #ffffff;
+ color: #000000;
+ font-family: "Bitstream Vera Sans", verdana, lucida, arial,
+ helvetica, sans-serif;
+ font-size: 11pt;
+ margin: 2% 5%;
+}
+h1, h2, h3, h4, h5, h6, h7
+{
+ background-color: #b2d599;
+ color: #000000;
+ text-align: left;
+ font-size: 11pt;
+ padding: 5px;
+}
+td.even, td.uneven
+{
+ color: #000000;
+ font-size: 10pt;
+}
+li
+{
+ font-size: 10pt;
+}
+td.even
+{
+ background-color: #eeeeee;
+}
+span.SOURCE
+{
+ white-space: pre;
+}
+pre
+{
+ background-color: #ffffff;
+ color: #000000;
+ font-size: 10pt;
+}
diff --git a/superkaramba/doc/python_api/api_html.rc b/superkaramba/doc/python_api/api_html.rc
new file mode 100644
index 0000000..18c6cbb
--- /dev/null
+++ b/superkaramba/doc/python_api/api_html.rc
@@ -0,0 +1,36 @@
+# Superkaramba python api html documentation config for ROBODOc
+#
+items:
+ SYNOPSIS
+ DESCRIPTION
+ ARGUMENTS
+ RETURN VALUE
+ignore items:
+options:
+ --singledoc
+ --src .apiHeaders
+ --doc python_api
+ --html
+ #--tell
+ --nopre
+ #--lock
+ #--index
+ --toc
+ --nodesc
+ --css api.css
+headertypes:
+ p "Python API" karamba_python_api
+ignore files:
+ README
+ CVS
+ *.bak
+ *~
+ *.cpp
+ Makefile*
+ *.rc
+header markers:
+ //****
+remark markers:
+ //
+end markers:
+ //***
diff --git a/superkaramba/doc/python_api/make_api_doc.sh b/superkaramba/doc/python_api/make_api_doc.sh
new file mode 100755
index 0000000..866c534
--- /dev/null
+++ b/superkaramba/doc/python_api/make_api_doc.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+#This script grabs the current *_python.h headers,
+# converts them to robodoc format, and then generates
+# the api documentation
+##########################################################
+SRCDIR=../../src/
+TEMPDIR=".apiHeaders"
+
+if [[ -d $TEMPDIR ]]; then
+ echo "Cleaning out existing $TEMPDIR directory"
+ rm -rf $TEMPDIR/*
+else
+ echo "Creating $TEMPDIR directory"
+ mkdir -p $TEMPDIR
+fi
+
+function replaceComments()
+{
+ echo "Converting file $1"
+ TEMPFILE="temp.h"
+ cat $1 | sed -e 's/^\/\*\*/\/\/\*\*\*\*p\*/' -e 's/^\*\//\/\/\*\*\*/' -e 's/^\*/\/\//' > $TEMPFILE
+ if [[ -s $TEMPFILE ]] ; then
+ mv $TEMPFILE $1
+ fi
+}
+
+
+FOO=`find $SRCDIR -type f -name "*_python.h"`
+
+for FILE in $FOO
+do
+ cp $FILE $TEMPDIR/
+done
+
+BAR=`ls $TEMPDIR`
+for FILE in $BAR
+do
+ replaceComments $TEMPDIR/$FILE
+done
+
+echo "Creating api documentation in output file: python_api.html"
+robodoc --rc api_html.rc