Commit d128fdb6 authored by Iustin Pop's avatar Iustin Pop

Add apidoc makefile target

The patch adds the apidoc target and the epydoc config file for it. Note
that this is for epydoc 3.0 and that it will put the docs into
./doc/api/.

The patch also adds a new .gitignore rule for the auto-generated rapi
fragment.

Reviewed-by: imsnah
parent 0e46916d
......@@ -28,9 +28,11 @@
/devel/upload
# doc
/doc/api
/doc/*.html
/doc/*.in
/doc/*.pdf
/doc/rapi-resources.sgml
# doc/examples
/doc/examples/ganeti.cron
......
......@@ -306,4 +306,17 @@ stamp-directories: Makefile
@mkdir_p@ $(DIRS)
touch $@
.PHONY: apidoc
apidoc:
test -e doc/api || mkdir doc/api
TMPDIR=`mktemp -d ./temp-epydoc.XXXXXX` && { \
cp -r scripts daemons lib $$TMPDIR && \
( \
cd $$TMPDIR && \
mv lib ganeti && \
epydoc --conf ../epydoc.conf \
) ; \
rm -rf $$TMPDIR ; \
}
# vim: set noet :
[epydoc]
name: Ganeti
url: http://code.google.com/p/ganeti/
output: html
target: ../doc/api
# note: the wildcards means the directories should be cleaned up after each
# run, otherwise there will be stale '*c' (compiled) files that will not be
# parsable and will break the epydoc run
modules: ganeti, scripts/gnt-*, daemons/ganeti-*
graph: all
simple-term: 1
docformat: epytext
imports: yes
include-log: no
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment