Makefile revision 4cff093bd6a1a474aff638f6ad32d56914c7488e 
1##===- 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
10LEVEL      := ..
11DIRS       :=
12
13ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
16
17$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
18	cat $< | sed \
19	  -e 's/@abs_top_srcdir@/../g' \
20	  -e 's/@DOT@/dot/g' \
21	  -e 's/@PACKAGE_VERSION@/mainline/' \
22	  -e 's/@abs_top_builddir@/../g' \
23	  -e 's/@enable_searchengine@/NO/g' \
24	  -e 's/@searchengine_url@//g' \
25	  -e 's/@enable_server_based_search@/NO/g' \
26	  -e 's/@enable_external_search@/NO/g' \
27	  -e 's/@extra_search_mappings@//g' > $@
28endif
29
30include $(LEVEL)/Makefile.common
31
32HTML       := $(wildcard $(PROJ_SRC_DIR)/*.html) \
33              $(wildcard $(PROJ_SRC_DIR)/*.css)
34DOXYFILES  := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
35              doxygen.intro
36EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide
37
38.PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc generated
39
40install_targets := install-html
41ifeq ($(ENABLE_DOXYGEN),1)
42install_targets += install-doxygen
43endif
44ifdef OCAMLDOC
45ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
46install_targets += install-ocamldoc
47endif
48endif
49install-local:: $(install_targets)
50
51generated_targets := doxygen
52ifdef OCAMLDOC
53generated_targets += ocamldoc
54endif
55
56# Live documentation is generated for the web site using this target:
57# 'make generated BUILD_FOR_WEBSITE=1'
58generated:: $(generated_targets)
59
60install-html: $(PROJ_OBJ_DIR)/html.tar.gz
61	$(Echo) Installing HTML documentation
62	$(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html
63	$(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html
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
71	$(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/html.tar
72
73install-doxygen: doxygen
74	$(Echo) Installing doxygen documentation
75	$(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/doxygen
76	$(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
77	$(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
78	  $(FIND) . -type f -exec \
79	    $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/html/doxygen \;
80
81doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
82
83regendoc:
84	$(Echo) Building doxygen documentation
85	$(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
86	  $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
87	fi
88	$(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
89
90$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
91	$(Echo) Packaging doxygen documentation
92	$(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
93	$(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
94	$(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/doxygen.tar
95	$(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
96
97userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
98
99$(LLVM_SRC_ROOT)/docs/userloc.html:
100	$(Echo) Making User LOC Table
101	$(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
102	  -html lib include tools runtime utils examples autoconf test > docs/userloc.html
103
104install-ocamldoc: ocamldoc
105	$(Echo) Installing ocamldoc documentation
106	$(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html
107	$(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(DESTDIR)$(PROJ_docsdir)
108	$(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
109	  $(FIND) . -type f -exec \
110	    $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html \;
111
112ocamldoc: regen-ocamldoc
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) $(GZIPBIN) $(PROJ_OBJ_DIR)/ocamldoc.tar
117	$(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/
118
119regen-ocamldoc:
120	$(Echo) Building ocamldoc documentation
121	$(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \
122		$(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \
123	fi
124	$(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
125	$(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
126	$(Verb) \
127		$(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
128		`$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'`
129
130uninstall-local::
131	$(Echo) Uninstalling Documentation
132	$(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir)
133