summaryrefslogtreecommitdiff
path: root/doc/Makefile
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2015-12-13 00:01:04 +0100
committerRémi Verschelde <rverschelde@gmail.com>2015-12-13 00:01:04 +0100
commit410e418aea16cc1c07249a9a64d3defcb8990866 (patch)
treeadec28ca65ff39bdc59ed26b427896d3a240b54e /doc/Makefile
parentaeb5ea59340f91ae445330c95429f903a8f20e8a (diff)
Add a Makefile to generate classes doc in various formats
All the generated documentation is put in doc/_build.
Diffstat (limited to 'doc/Makefile')
-rw-r--r--doc/Makefile47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000000..286a5162af
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,47 @@
+BASEDIR = $(CURDIR)
+CLASSES = $(BASEDIR)/base/classes.xml
+OUTPUTDIR = $(BASEDIR)/_build
+TOOLSDIR = $(BASEDIR)/tools
+
+.ONESHELL:
+
+clean:
+ rm -rf $(OUTPUTDIR)
+
+doku:
+ rm -rf $(OUTPUTDIR)/doku
+ mkdir -p $(OUTPUTDIR)/doku
+ pushd $(OUTPUTDIR)/doku
+ python2 $(TOOLSDIR)/makedoku.py $(CLASSES)
+ popd
+
+doxygen:
+ rm -rf $(OUTPUTDIR)/doxygen
+ mkdir -p $(OUTPUTDIR)/doxygen
+ doxygen Doxyfile
+
+html:
+ rm -rf $(OUTPUTDIR)/html
+ mkdir -p $(OUTPUTDIR)/html
+ pushd $(OUTPUTDIR)/html
+ python2 $(TOOLSDIR)/makehtml.py -multipage $(CLASSES)
+ popd
+
+markdown:
+ rm -rf $(OUTPUTDIR)/markdown
+ mkdir -p $(OUTPUTDIR)/markdown
+ pushd $(OUTPUTDIR)/markdown
+ python2 $(TOOLSDIR)/makemd.py $(CLASSES)
+ popd
+
+rst:
+ rm -rf $(OUTPUTDIR)/rst
+ mkdir -p $(OUTPUTDIR)/rst
+ pushd $(OUTPUTDIR)/rst
+ echo "TODO"
+ popd
+
+textile:
+ rm -rf $(OUTPUTDIR)/textile
+ mkdir -p $(OUTPUTDIR)/textile
+ python3 $(TOOLSDIR)/makedocs.py --input $(CLASSES) --output $(OUTPUTDIR)/textile