Adding ocamldoc generation.
[oota-llvm.git] / docs / Makefile
index c15f1cc345c4152d80495ed0b439805650a0df3b..1b5987914dc1ff30776771a05050f02344f0c2ae 100644 (file)
@@ -2,14 +2,26 @@
 # 
 #                     The LLVM Compiler Infrastructure
 #
-# This file was developed by the LLVM research group and is distributed under
-# the University of Illinois Open Source License. See LICENSE.TXT for details.
+# This file is distributed under the University of Illinois Open Source
+# License. See LICENSE.TXT for details.
 # 
 ##===----------------------------------------------------------------------===##
 
 LEVEL      := ..
 DIRS       := CommandGuide
 
+ifdef BUILD_FOR_WEBSITE
+PROJ_OBJ_DIR = .
+DOXYGEN = doxygen
+
+$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
+       cat $< | sed \
+         -e 's/@abs_top_srcdir@/../g' \
+         -e 's/@DOT@/dot/g' \
+         -e 's/@PACKAGE_VERSION@/mainline/' \
+         -e 's/@abs_top_builddir@/../g' > $@
+endif
+
 include $(LEVEL)/Makefile.common
 
 HTML       := $(wildcard $(PROJ_SRC_DIR)/*.html) \
@@ -19,21 +31,24 @@ DOXYFILES  := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
               doxygen.intro
 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
 
-.PHONY: install-html install-doxygen doxygen
+.PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc
 
+install_targets := install-html
 ifeq ($(ENABLE_DOXYGEN),1)
-install-local:: install-html install-doxygen
-else
-install-local:: install-html
+install_targets += install-doxygen
+endif
+ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
+install_targets += install-ocamldoc
 endif
+install-local:: $(install_targets)
 
 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
        $(Echo) Installing HTML documentation
-       $(Verb) $(INSTALL) -d $(PROJ_docsdir)/html
-       $(Verb) $(INSTALL) -d $(PROJ_docsdir)/html/img
-       $(Verb) $(INSTALL) -C $(HTML) $(PROJ_docsdir)/html
-       $(Verb) $(INSTALL) -C $(IMAGES) $(PROJ_docsdir)/html/img
-       $(Verb) $(INSTALL) -C $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
+       $(Verb) $(MKDIR) $(PROJ_docsdir)/html
+       $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
+       $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
+       $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
+       $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
 
 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
        $(Echo) Packaging HTML documentation
@@ -44,23 +59,59 @@ $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
 
 install-doxygen: doxygen
        $(Echo) Installing doxygen documentation
-       $(Echo) Installing doxygen documentation
-       $(Verb) $(INSTALL) -d $(PROJ_docsdir)/html/doxygen
-       $(Verb) $(INSTALL) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
+       $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
+       $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
        $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
          $(FIND) . -type f -exec \
-           $(INSTALL) -C {} $(PROJ_docsdir)/html/doxygen \;
+           $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
 
-doxygen: $(PROJ_OBJ_DIR)/doxygen.tar.gz
+doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
 
-$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
+regendoc:
        $(Echo) Building doxygen documentation
        $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
          $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
        fi
        $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
+
+$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
        $(Echo) Packaging doxygen documentation
        $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
        $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
        $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
+       $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
+
+userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
+
+$(LLVM_SRC_ROOT)/docs/userloc.html:
+       $(Echo) Making User LOC Table
+       $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
+         -html lib include tools runtime utils examples autoconf test > docs/userloc.html
+
+install-ocamldoc: ocamldoc
+       $(Echo) Installing ocamldoc documentation
+       $(Verb) $(MKDIR) $(PROJ_docsdir)/ocamldoc/html
+       $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_docsdir)
+       $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
+         $(FIND) . -type f -exec \
+           $(DataInstall) {} $(PROJ_docsdir)/ocamldoc/html \;
+
+ocamldoc: regen-ocamldoc $(PROJ_OBJ_DIR)/ocamldoc.tar.gz
+
+regen-ocamldoc:
+       $(Echo) Building ocamldoc documentation
+       $(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \
+               $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \
+       fi
+       $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
+       $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
+       $(Verb) \
+               $(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
+               `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'`
 
+$(PROJ_OBJ_DIR)/ocamldoc.tar.gz:
+       $(Echo) Packaging ocamldoc documentation
+       $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/ocamldoc.tar
+       $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc
+       $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/ocamldoc.tar
+       $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/