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