blob: a409cf6025bdfefc2237ab344ffc08d5f0f559b5 [file] [log] [blame]
Daniel Dunbar086fe1a2008-07-26 21:32:24 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
5# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
7#
8##===----------------------------------------------------------------------===##
9
Daniel Dunbare6c1daa2010-06-08 20:34:18 +000010CLANG_LEVEL := ..
mike-m9f08a6f2010-05-07 00:42:33 +000011
12ifdef BUILD_FOR_WEBSITE
13PROJ_OBJ_DIR = .
14DOXYGEN = doxygen
15
16$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
17 cat $< | sed \
mike-m9f08a6f2010-05-07 00:42:33 +000018 -e 's/@DOT@/dot/g' \
19 -e 's/@PACKAGE_VERSION@/mainline/' \
Michael Gottesman22a351d2013-08-28 20:29:44 +000020 -e 's/@abs_builddir@/./g' \
Logan Chien6f43a4f2015-03-12 17:27:19 +000021 -e 's/@abs_srcdir@/./g' \
22 -e 's/@clang_doxygen_generate_qhp@/NO/g' \
23 -e 's/@clang_doxygen_qch_filename@//g' \
24 -e 's/@clang_doxygen_qhelpgenerator_path@//g' \
25 -e 's/@clang_doxygen_qhp_cust_filter_attrs@//g' \
26 -e 's/@clang_doxygen_qhp_cust_filter_name@//g' \
27 -e 's/@clang_doxygen_qhp_namespace@//g' \
Michael Gottesman22a351d2013-08-28 20:29:44 +000028 -e 's/@enable_external_search@/NO/g' \
Logan Chien6f43a4f2015-03-12 17:27:19 +000029 -e 's/@enable_searchengine@/NO/g' \
30 -e 's/@enable_server_based_search@/NO/g' \
31 -e 's/@extra_search_mappings@//g' \
32 -e 's/@searchengine_url@//g' \
33 > $@
mike-m9f08a6f2010-05-07 00:42:33 +000034endif
Daniel Dunbar086fe1a2008-07-26 21:32:24 +000035
Daniel Dunbare6c1daa2010-06-08 20:34:18 +000036include $(CLANG_LEVEL)/Makefile
mike-m9f08a6f2010-05-07 00:42:33 +000037
38HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
39 $(wildcard $(PROJ_SRC_DIR)/*.css)
40#IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Logan Chien0d59d602015-03-12 17:27:53 +000041DOXYFILES := doxygen.cfg.in doxygen.intro
mike-m9f08a6f2010-05-07 00:42:33 +000042
43.PHONY: install-html install-doxygen doxygen generated
44
45install_targets :=
46ifndef ONLY_MAN_DOCS
47install_targets += install-html
48endif
49ifeq ($(ENABLE_DOXYGEN),1)
50install_targets += install-doxygen
51endif
52install-local:: $(install_targets)
53
54# Live documentation is generated for the web site using this target:
55# 'make generated BUILD_FOR_WEBSITE=1'
56generated:: doxygen
57
58install-html: $(PROJ_OBJ_DIR)/html.tar.gz
59 $(Echo) Installing HTML documentation
60 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html
61 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/img
62 $(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html
63# $(Verb) $(DataInstall) $(IMAGES) $(DESTDIR)$(PROJ_docsdir)/html/img
64 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(DESTDIR)$(PROJ_docsdir)
65
66$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
67 $(Echo) Packaging HTML documentation
68 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
69 $(Verb) cd $(PROJ_SRC_DIR) && \
70 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
Eric Christopherb0fd4592010-12-10 01:59:28 +000071 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/html.tar
mike-m9f08a6f2010-05-07 00:42:33 +000072
73install-doxygen: doxygen
74 $(Echo) Installing doxygen documentation
mike-m9f08a6f2010-05-07 00:42:33 +000075 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
Logan Chien0d59d602015-03-12 17:27:53 +000076 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen/html && \
77 for DIR in $$($(FIND) . -type d); do \
78 DESTSUB="$(DESTDIR)$(PROJ_docsdir)/html/doxygen/$$(echo $$DIR | cut -c 3-)"; \
79 $(MKDIR) $$DESTSUB && \
80 $(FIND) $$DIR -maxdepth 1 -type f -exec $(DataInstall) {} $$DESTSUB \; ; \
81 if [ $$? != 0 ]; then exit 1; fi \
82 done
mike-m9f08a6f2010-05-07 00:42:33 +000083
84doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
85
86regendoc:
87 $(Echo) Building doxygen documentation
David Majnemer6fcf92a2013-10-15 08:33:43 +000088 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/doxygen
mike-m9f08a6f2010-05-07 00:42:33 +000089 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Bill Wendling9020b432013-10-27 05:00:50 +000090 $(Verb) sed -i "s/[$$]LatestRev[$$]/`svnversion $(PROJ_SRC_DIR)`/g" \
91 $(PROJ_OBJ_DIR)/doxygen/html/*.html
mike-m9f08a6f2010-05-07 00:42:33 +000092
93$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
94 $(Echo) Packaging doxygen documentation
95 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
96 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
Eric Christopherb0fd4592010-12-10 01:59:28 +000097 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/doxygen.tar
mike-m9f08a6f2010-05-07 00:42:33 +000098 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
99
100userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
101
102$(LLVM_SRC_ROOT)/docs/userloc.html:
103 $(Echo) Making User LOC Table
104 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
105 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
106
107uninstall-local::
108 $(Echo) Uninstalling Documentation
109 $(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir)