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