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