docs/Makefile.am

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