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/.libs/libgst.so $(top_srcdir)/gst/elements/.libs/libgstelements.so
  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/gstinfo.sgml               \
  26         tmpl/gstasyncdisksrc.sgml       \
  27         tmpl/gstautoplug.sgml           \
  28         tmpl/gstscheduler.sgml          \
  29         tmpl/gstprops.sgml              \
  30         tmpl/gstcaps.sgml               \
  31         tmpl/gstaudiosink.sgml          \
  32         tmpl/gstaudiosrc.sgml           \
  33         tmpl/gstbin.sgml                \
  34         tmpl/gstbuffer.sgml             \
  35         tmpl/gstbufferpool.sgml         \
  36         tmpl/gstdisksrc.sgml            \
  37         tmpl/gstelement.sgml            \
  38         tmpl/gstesdsink.sgml            \
  39         tmpl/gstfakesink.sgml           \
  40         tmpl/gstfakesrc.sgml            \
  41         tmpl/gstfdsink.sgml             \
  42         tmpl/gstfdsrc.sgml              \
  43         tmpl/gsthttpsrc.sgml            \
  44         tmpl/gstidentity.sgml           \
  45         tmpl/gstlog.sgml                \
  46         tmpl/gstmeta.sgml               \
  47         tmpl/gstobject.sgml             \
  48         tmpl/gstpad.sgml                \
  49         tmpl/gstpipeline.sgml           \
  50         tmpl/gstplugin.sgml             \
  51         tmpl/gstqueue.sgml              \
  52         tmpl/gstreamer-unused.sgml      \
  53         tmpl/gstsinesrc.sgml            \
  54         tmpl/gsttee.sgml                \
  55         tmpl/gstthread.sgml             \
  56         tmpl/gsttrace.sgml              \
  57         tmpl/gsttype.sgml               \
  58         tmpl/gstutils.sgml              \
  59         tmpl/gstxml.sgml                \
  60         tmpl/spectrum.sgml              \
  61         tmpl/videoraw.sgml
  62
  63 gstreamer_docdir = $(HTML_DIR)
  64 gstreamer_doc_DATA =            \
  65         gstreamer.html          \
  66         gstreamer.hierarchy     \
  67         gstreamer.types         \
  68         gstreamer-decl.txt      \
  69         gstreamer-sections.txt
  70
  71 SCANOBJS_FILES =                \
  72         $(DOC_MODULE).signals   \
  73         $(DOC_MODULE).hierarchy \
  74         $(DOC_MODULE).args
  75
  76 if HAVE_GTK_DOC
  77 gstreamer.html: html/book1.html
  78         -cd $(srcdir) && cp html/book1.html gstreamer.html
  79 else
  80 gstreamer.html:
  81 endif
  82
  83 html/book1.html: sgml/gstreamer-doc.bottom
  84         $(MAKE) html
  85
  86 sgml/gstreamer-doc.bottom: $(tmpl_sources)
  87         $(MAKE) sgml
  88
  89 gstreamer-decl.txt:
  90         $(MAKE) scan
  91
  92 scanobj: $(srcdir)/$(DOC_MODULE).types
  93         -CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE)
  94         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
  95
  96
  97 scan:
  98         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
  99
 100 tmpl: scanobj scan
 101         gtkdoc-mktmpl --module=$(DOC_MODULE)
 102
 103 sgml: tmpl
 104         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
 105
 106 html: sgml
 107         if ! test -d html ; then mkdir html ; fi
 108         -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 109
 110 clean-local:
 111         rm -f *~ *.bak *.signals *-unused.txt *.args
 112
 113 maintainer-clean-local: clean
 114         rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 115
 116 install-data-local:
 117         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 118         (installfiles=`echo $(srcdir)/html/*.html`; \
 119         if test "$$installfiles" = '$(srcdir)/html/*.html'; \
 120         then echo '-- Nothing to install' ; \
 121         else \
 122           for i in $$installfiles; do \
 123             echo '-- Installing '$$i ; \
 124             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 125           done; \
 126           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 127           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 128           echo '-- Fixing Crossreferences' ; \
 129           gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
 130         fi)
 131
 132 dist-hook:
 133         mkdir $(distdir)/html
 134         mkdir $(distdir)/sgml
 135         mkdir $(distdir)/tmpl
 136         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
 137         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 138         -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 139         -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
 140
 141 .PHONY : html sgml templates scan