docs/gst/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # The name of the module.
   4 DOC_MODULE=gstreamer
   5
   6 # The top-level SGML file.
   7 DOC_MAIN_SGML_FILE=gstreamer-docs.sgml
   8
   9 # The directory containing the source code (if it contains documentation).
  10 DOC_SOURCE_DIR=$(top_srcdir)/gst
  11
  12 CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir)
  13 LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la $(top_srcdir)/gst/elements/libgstelements.la
  14
  15 EXTRA_DIST=gstreamer.types.in
  16
  17 HTML_DIR=$(datadir)/gstreamer/html
  18
  19 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  20
  21 tmpl_sources =                          \
  22         tmpl/audioraw.sgml              \
  23         tmpl/cothreads.sgml             \
  24         tmpl/gst.sgml                   \
  25         tmpl/gstasyncdisksrc.sgml       \
  26         tmpl/gstaudiosink.sgml          \
  27         tmpl/gstaudiosrc.sgml           \
  28         tmpl/gstbin.sgml                \
  29         tmpl/gstbuffer.sgml             \
  30         tmpl/gstconnection.sgml         \
  31         tmpl/gstdisksrc.sgml            \
  32         tmpl/gstelement.sgml            \
  33         tmpl/gstesdsink.sgml            \
  34         tmpl/gstfakesink.sgml           \
  35         tmpl/gstfakesrc.sgml            \
  36         tmpl/gstfdsink.sgml             \
  37         tmpl/gstfdsrc.sgml              \
  38         tmpl/gstfilter.sgml             \
  39         tmpl/gsthttpsrc.sgml            \
  40         tmpl/gstidentity.sgml           \
  41         tmpl/gstlog.sgml                \
  42         tmpl/gstmeta.sgml               \
  43         tmpl/gstobject.sgml             \
  44         tmpl/gstpad.sgml                \
  45         tmpl/gstpipeline.sgml           \
  46         tmpl/gstplugin.sgml             \
  47         tmpl/gstqueue.sgml              \
  48         tmpl/gstreamer-unused.sgml      \
  49         tmpl/gstsinesrc.sgml            \
  50         tmpl/gstsink.sgml               \
  51         tmpl/gstsrc.sgml                \
  52         tmpl/gsttee.sgml                \
  53         tmpl/gstthread.sgml             \
  54         tmpl/gsttrace.sgml              \
  55         tmpl/gsttype.sgml               \
  56         tmpl/gstutils.sgml              \
  57         tmpl/gstxml.sgml                \
  58         tmpl/spectrum.sgml              \
  59         tmpl/videoraw.sgml
  60
  61 gstreamer_docdir = $(HTML_DIR)
  62 gstreamer_doc_DATA =            \
  63         gstreamer.html          \
  64         gstreamer.hierarchy     \
  65         gstreamer.types         \
  66         gstreamer-decl.txt      \
  67         gstreamer-sections.txt
  68
  69 SCANOBJS_FILES =                \
  70         $(DOC_MODULE).signals   \
  71         $(DOC_MODULE).hierarchy \
  72         $(DOC_MODULE).args
  73
  74 if HAVE_GTK_DOC
  75 gstreamer.html: html/book1.html
  76         -cd $(srcdir) && cp html/book1.html gstreamer.html
  77 else
  78 gstreamer.html:
  79 endif
  80
  81 html/book1.html: sgml/gstreamer-doc.bottom
  82         $(MAKE) html
  83
  84 sgml/gstreamer-doc.bottom: $(tmpl_sources)
  85         $(MAKE) sgml
  86
  87 gstreamer-decl.txt:
  88         $(MAKE) scan
  89
  90 scanobj: $(srcdir)/$(DOC_MODULE).types
  91         env CC="$(LIBTOOL) --mode=link $(CC)" CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" \
  92                 gtkdoc-scanobj --module=$(DOC_MODULE) \
  93                 --types=$(srcdir)/$(DOC_MODULE).types
  94
  95 scan:
  96         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gsttypefind.h"
  97
  98 tmpl: scanobj scan
  99         gtkdoc-mktmpl --module=$(DOC_MODULE)
 100
 101 sgml: tmpl
 102         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
 103
 104 html:
 105         if ! test -d html ; then mkdir html ; fi
 106         -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 107
 108 clean-local:
 109         rm -f *~ *.bak *.signals *-unused.txt *.args
 110
 111 maintainer-clean-local: clean
 112         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           echo '-- Fixing Crossreferences' ; \
 127           gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
 128         fi)
 129
 130 dist-hook:
 131         mkdir $(distdir)/html
 132         mkdir $(distdir)/sgml
 133         mkdir $(distdir)/tmpl
 134         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
 135         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 136         -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 137         -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
 138
 139 .PHONY : html sgml templates scan