Add version info to API docs.
[platform/upstream/glib.git] / docs / reference / gobject / Makefile.am
1 ## Process this file with automake to produce Makefile.in
2
3 # The name of the module.
4 DOC_MODULE=gobject
5
6 # The top-level SGML file.
7 DOC_MAIN_SGML_FILE=gobject-docs.sgml
8
9 # The directory containing the source code. Relative to $(srcdir)
10 DOC_SOURCE_DIR=../../../gobject
11
12 # Extra options to supply to gtkdoc-scan
13 SCAN_OPTIONS=
14
15 # Extra options to supply to gtkdoc-mkdb
16 MKDB_OPTIONS=--output-format=xml
17
18 # Extra options to supply to gtkdoc-fixref
19 FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
20
21 # Used for dependencies
22 HFILE_GLOB=$(top_srcdir)/gobject/*.h
23 CFILE_GLOB=$(top_srcdir)/gobject/*.c
24
25 # Headers to ignore
26 IGNORE_HFILES=
27
28 # Extra files to add when scanning
29 EXTRA_HFILES=
30
31 # Images to copy into HTML directory
32 HTML_IMAGES =
33
34 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
35 content_files = version.xml
36
37 # Other files to distribute
38 extra_files = version.xml.in
39
40 # CFLAGS and LDFLAGS for compiling scan program. Only needed
41 # if $(DOC_MODULE).types is non-empty.
42 GTKDOC_CFLAGS =
43 GTKDOC_LIBS =
44
45 # Commands for compiling and linking 
46 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
47 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
48
49
50 ####################################
51 # Everything below here is generic #
52 ####################################
53
54 # We set GPATH here; this gives us semantics for GNU make
55 # which are more like other make's VPATH, when it comes to
56 # whether a source that is a target of one rule is then
57 # searched for in VPATH/GPATH.
58 #
59 GPATH = $(srcdir)
60
61 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
62
63 EXTRA_DIST =                            \
64         $(content_files)                \
65         $(extra_files)                  \
66         $(HTML_IMAGES)                  \
67         $(DOC_MAIN_SGML_FILE)           \
68         $(DOC_MODULE).types             \
69         $(DOC_MODULE)-sections.txt      \
70         $(DOC_MODULE)-overrides.txt
71
72 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
73            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
74
75 SCANOBJ_FILES =                  \
76         $(DOC_MODULE).args       \
77         $(DOC_MODULE).hierarchy  \
78         $(DOC_MODULE).interfaces \
79         $(DOC_MODULE).prerequisites \
80         $(DOC_MODULE).signals
81
82 if ENABLE_GTK_DOC
83 all-local: html-build.stamp
84
85 #### scan ####
86
87 scan-build.stamp: $(HFILE_GLOB)
88         @echo '*** Scanning header files ***'
89         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
90             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
91         else \
92             cd $(srcdir) ; \
93             for i in $(SCANOBJ_FILES) ; do \
94                test -f $$i || touch $$i ; \
95             done \
96         fi
97         cd $(srcdir) && \
98           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
99         touch scan-build.stamp
100
101 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
102         @true
103
104 #### templates ####
105
106 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
107         @echo '*** Rebuilding template files ***'
108         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
109         touch tmpl-build.stamp
110
111 tmpl.stamp: tmpl-build.stamp
112         @true
113
114 #### sgml ####
115
116 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
117         @echo '*** Building SGML ***'
118         cd $(srcdir) && \
119         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
120         touch sgml-build.stamp
121
122 sgml.stamp: sgml-build.stamp
123         @true
124
125 #### html ####
126
127 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
128         @echo '*** Building HTML ***'
129         rm -rf $(srcdir)/html 
130         mkdir $(srcdir)/html
131         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
132         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
133         @echo '-- Fixing Crossreferences' 
134         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
135         touch html-build.stamp
136 endif
137
138 ##############
139
140 clean-local:
141         rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
142
143 maintainer-clean-local: clean
144         cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
145
146 install-data-local:
147         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
148         (installfiles=`echo $(srcdir)/html/*`; \
149         if test "$$installfiles" = '$(srcdir)/html/*'; \
150         then echo '-- Nothing to install' ; \
151         else \
152           for i in $$installfiles; do \
153             echo '-- Installing '$$i ; \
154             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
155           done; \
156           echo '-- Installing $(srcdir)/html/index.sgml' ; \
157           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
158         fi)
159
160 #
161 # Require gtk-doc when making dist
162 #
163 if ENABLE_GTK_DOC
164 dist-check-gtkdoc:
165 else
166 dist-check-gtkdoc:
167         @echo "*** gtk-doc must be installed and enabled in order to make dist"
168         @false
169 endif
170
171 dist-hook: dist-check-gtkdoc dist-hook-local
172         mkdir $(distdir)/tmpl
173         mkdir $(distdir)/xml
174         mkdir $(distdir)/html
175         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
176         -cp $(srcdir)/xml/*.xml $(distdir)/xml
177         -cp $(srcdir)/html/* $(distdir)/html
178
179 .PHONY : dist-hook-local