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' > $@
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
36 ifeq ($(ENABLE_DOXYGEN),1)
37 install-local:: install-html install-doxygen
39 install-local:: install-html
42 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
43 $(Echo) Installing HTML documentation
44 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
45 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
46 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
47 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
48 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
50 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
51 $(Echo) Packaging HTML documentation
52 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
53 $(Verb) cd $(PROJ_SRC_DIR) && \
54 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
55 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
57 install-doxygen: doxygen
58 $(Echo) Installing doxygen documentation
59 $(Echo) Installing doxygen documentation
60 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
61 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
62 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
63 $(FIND) . -type f -exec \
64 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
66 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
69 $(Echo) Building doxygen documentation
70 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
71 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
73 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
75 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
76 $(Echo) Packaging doxygen documentation
77 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
78 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
79 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
80 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
82 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
84 $(LLVM_SRC_ROOT)/docs/userloc.html:
85 $(Echo) Making User LOC Table
86 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
87 -html lib include tools runtime utils examples autoconf test > docs/userloc.html