1 ## Process this file with automake to produce Makefile.in
3 # The name of the module.
6 # The top-level SGML file.
7 DOC_MAIN_SGML_FILE=glib-docs.sgml
9 # The directory containing the source code. Relative to $(srcdir)
10 DOC_SOURCE_DIR=../../..
12 # Extra options to supply to gtkdoc-scan
13 SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
15 # Extra options to supply to gtkdoc-mkdb
18 # Extra options to supply to gtkdoc-fixref
21 # Used for dependencies
22 HFILE_GLOB=$(top_srcdir)/*.h $(top_srcdir)/gmodule/*.h
23 CFILE_GLOB=$(top_srcdir)/*.c $(top_srcdir)/gmodule/*.c
36 # Extra files to add when scanning
39 # Images to copy into HTML directory
43 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
46 # Other files to distribute
52 # CFLAGS and LDFLAGS for compiling scan program. Only needed
53 # if $(DOC_MODULE).types is non-empty.
57 # Commands for compiling and linking
58 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
59 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
62 ####################################
63 # Everything below here is generic #
64 ####################################
66 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
72 $(DOC_MAIN_SGML_FILE) \
74 $(DOC_MODULE)-sections.txt \
75 $(DOC_MODULE)-overrides.txt
77 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
78 $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
82 $(DOC_MODULE).hierarchy \
86 all-local: html-build.stamp
90 scan-build.stamp: $(HFILE_GLOB)
91 @echo '*** Scanning header files ***'
92 if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
93 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
96 for i in $(SCANOBJ_FILES) ; do \
97 test -f $$i || touch $$i ; \
101 gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
102 touch scan-build.stamp
104 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
109 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
110 @echo '*** Rebuilding template files ***'
111 cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
112 touch tmpl-build.stamp
114 tmpl.stamp: tmpl-build.stamp
119 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
120 @echo '*** Building SGML ***'
122 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
123 touch sgml-build.stamp
125 sgml.stamp: sgml-build.stamp
130 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
131 @echo '*** Building HTML ***'
132 test -d $(srcdir)/html || mkdir $(srcdir)/html
133 cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
134 test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
135 @echo '-- Fixing Crossreferences'
136 cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
137 touch html-build.stamp
143 rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
145 maintainer-clean-local: clean
146 cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
149 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
150 (installfiles=`echo $(srcdir)/html/*.html`; \
151 if test "$$installfiles" = '$(srcdir)/html/*.html'; \
152 then echo '-- Nothing to install' ; \
154 for i in $$installfiles; do \
155 echo '-- Installing '$$i ; \
156 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
158 echo '-- Installing $(srcdir)/html/index.sgml' ; \
159 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
163 # Require gtk-doc when making dist
169 @echo "*** gtk-doc must be installed and enabled in order to make dist"
173 dist-hook: dist-check-gtkdoc dist-hook-local
174 mkdir $(distdir)/tmpl
175 mkdir $(distdir)/sgml
176 mkdir $(distdir)/html
177 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
178 -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
179 cp $(srcdir)/html/index.sgml $(distdir)/html
180 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
182 images=$(HTML_IMAGES) ; \
183 for i in $$images ; do \
184 cp $(srcdir)/$$i $(distdir)/html ; \
187 .PHONY : dist-hook-local