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 ##===----------------------------------------------------------------------===##
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' \
23 -e 's/@enable_searchengine@/NO/g' \
24 -e 's/@enable_server_based_search@/NO/g' \
25 -e 's/@enable_external_search@/NO/g' \
26 -e 's/@extra_search_mappings@/NO/g' > $@
29 include $(LEVEL)/Makefile.common
31 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
32 $(wildcard $(PROJ_SRC_DIR)/*.css)
33 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
35 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide
37 .PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc generated
39 install_targets := install-html
40 ifeq ($(ENABLE_DOXYGEN),1)
41 install_targets += install-doxygen
44 ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
45 install_targets += install-ocamldoc
48 install-local:: $(install_targets)
50 generated_targets := doxygen
52 generated_targets += ocamldoc
55 # Live documentation is generated for the web site using this target:
56 # 'make generated BUILD_FOR_WEBSITE=1'
57 generated:: $(generated_targets)
59 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
60 $(Echo) Installing HTML documentation
61 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html
62 $(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html
63 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(DESTDIR)$(PROJ_docsdir)
65 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
66 $(Echo) Packaging HTML documentation
67 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
68 $(Verb) cd $(PROJ_SRC_DIR) && \
69 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
70 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/html.tar
72 install-doxygen: doxygen
73 $(Echo) Installing doxygen documentation
74 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/doxygen
75 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
76 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
77 $(FIND) . -type f -exec \
78 $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/html/doxygen \;
80 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
83 $(Echo) Building doxygen documentation
84 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
85 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
87 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
89 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
90 $(Echo) Packaging doxygen documentation
91 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
92 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
93 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/doxygen.tar
94 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
96 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
98 $(LLVM_SRC_ROOT)/docs/userloc.html:
99 $(Echo) Making User LOC Table
100 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
101 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
103 install-ocamldoc: ocamldoc
104 $(Echo) Installing ocamldoc documentation
105 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html
106 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(DESTDIR)$(PROJ_docsdir)
107 $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
108 $(FIND) . -type f -exec \
109 $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html \;
111 ocamldoc: regen-ocamldoc
112 $(Echo) Packaging ocamldoc documentation
113 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc.tar*
114 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc
115 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/ocamldoc.tar
116 $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/
119 $(Echo) Building ocamldoc documentation
120 $(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \
121 $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \
123 $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
124 $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
126 $(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
127 `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'`
130 $(Echo) Uninstalling Documentation
131 $(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir)