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