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