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
20 -e 's/@PACKAGE_VERSION@/mainline/' \
21 -e 's/@abs_top_builddir@/../g' \
22 -e 's/@abs_top_srcdir@/../g' \
23 -e 's/@enable_external_search@/NO/g' \
24 -e 's/@enable_searchengine@/NO/g' \
25 -e 's/@enable_server_based_search@/NO/g' \
26 -e 's/@extra_search_mappings@//g' \
27 -e 's/@llvm_doxygen_generate_qhp@//g' \
28 -e 's/@llvm_doxygen_qch_filename@//g' \
29 -e 's/@llvm_doxygen_qhelpgenerator_path@//g' \
30 -e 's/@llvm_doxygen_qhp_cust_filter_attrs@//g' \
31 -e 's/@llvm_doxygen_qhp_cust_filter_name@//g' \
32 -e 's/@llvm_doxygen_qhp_namespace@//g' \
33 -e 's/@searchengine_url@//g' \
37 include $(LEVEL)/Makefile.common
39 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
40 $(wildcard $(PROJ_SRC_DIR)/*.css)
41 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
43 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide
45 .PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc generated
47 install_targets := install-html
48 ifeq ($(ENABLE_DOXYGEN),1)
49 install_targets += install-doxygen
52 ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
53 install_targets += install-ocamldoc
56 install-local:: $(install_targets)
58 generated_targets := doxygen
60 generated_targets += ocamldoc
63 # Live documentation is generated for the web site using this target:
64 # 'make generated BUILD_FOR_WEBSITE=1'
65 generated:: $(generated_targets)
67 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
68 $(Echo) Installing HTML documentation
69 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html
70 $(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html
71 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(DESTDIR)$(PROJ_docsdir)
73 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
74 $(Echo) Packaging HTML documentation
75 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
76 $(Verb) cd $(PROJ_SRC_DIR) && \
77 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
78 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/html.tar
80 install-doxygen: doxygen
81 $(Echo) Installing doxygen documentation
82 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/doxygen
83 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
84 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
85 $(FIND) . -type f -exec \
86 $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/html/doxygen \;
88 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
91 $(Echo) Building doxygen documentation
92 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/doxygen
93 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
95 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
96 $(Echo) Packaging doxygen documentation
97 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
98 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
99 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/doxygen.tar
100 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
102 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
104 $(LLVM_SRC_ROOT)/docs/userloc.html:
105 $(Echo) Making User LOC Table
106 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
107 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
109 install-ocamldoc: ocamldoc
110 $(Echo) Installing ocamldoc documentation
111 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html
112 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(DESTDIR)$(PROJ_docsdir)
113 $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
114 $(FIND) . -type f -exec \
115 $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html \;
117 ocamldoc: regen-ocamldoc
118 $(Echo) Packaging ocamldoc documentation
119 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc.tar*
120 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc
121 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/ocamldoc.tar
122 $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/
125 $(Echo) Building ocamldoc documentation
126 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc
127 $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
128 $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
130 $(OCAMLFIND) ocamldoc -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
131 `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" \
132 -path "*/$(BuildMode)/*.odoc" -exec echo -load '{}' ';'`
135 $(Echo) Uninstalling Documentation
136 $(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir)