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