1 ##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
3 # The LLVM Compiler Infrastructure
5 # This file is distributed under the University of Illinois Open Source
6 # License. See LICENSE.TXT for details.
8 ##===----------------------------------------------------------------------===##
11 DIRS := CommandGuide tutorial
13 ifdef BUILD_FOR_WEBSITE
17 $(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
19 -e 's/@abs_top_srcdir@/../g' \
21 -e 's/@PACKAGE_VERSION@/mainline/' \
22 -e 's/@abs_top_builddir@/../g' > $@
25 include $(LEVEL)/Makefile.common
27 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
28 $(wildcard $(PROJ_SRC_DIR)/*.css)
29 IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
30 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
32 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
34 .PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc
36 install_targets := install-html
37 ifeq ($(ENABLE_DOXYGEN),1)
38 install_targets += install-doxygen
40 ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
41 install_targets += install-ocamldoc
43 install-local:: $(install_targets)
45 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
46 $(Echo) Installing HTML documentation
47 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
49 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
50 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
51 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
53 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
54 $(Echo) Packaging HTML documentation
55 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
56 $(Verb) cd $(PROJ_SRC_DIR) && \
57 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
58 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
60 install-doxygen: doxygen
61 $(Echo) Installing doxygen documentation
62 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
63 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
64 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
65 $(FIND) . -type f -exec \
66 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
68 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
71 $(Echo) Building doxygen documentation
72 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
73 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
75 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
77 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
78 $(Echo) Packaging doxygen documentation
79 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
80 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
81 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
82 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
84 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
86 $(LLVM_SRC_ROOT)/docs/userloc.html:
87 $(Echo) Making User LOC Table
88 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
89 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
91 install-ocamldoc: ocamldoc
92 $(Echo) Installing ocamldoc documentation
93 $(Verb) $(MKDIR) $(PROJ_docsdir)/ocamldoc/html
94 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_docsdir)
95 $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
96 $(FIND) . -type f -exec \
97 $(DataInstall) {} $(PROJ_docsdir)/ocamldoc/html \;
99 ocamldoc: regen-ocamldoc $(PROJ_OBJ_DIR)/ocamldoc.tar.gz
102 $(Echo) Building ocamldoc documentation
103 $(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \
104 $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \
106 $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
107 $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
109 $(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
110 `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'`
112 $(PROJ_OBJ_DIR)/ocamldoc.tar.gz:
113 $(Echo) Packaging ocamldoc documentation
114 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/ocamldoc.tar
115 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc
116 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/ocamldoc.tar
117 $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/
120 $(Echo) Uninstalling Documentation
121 $(Verb) $(RM) -rf $(PROJ_docsdir)