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=$(DOC_MODULE)-docs.sgml
   8
   9 # The directory containing the source code (if it contains documentation).
  10 DOC_SOURCE_DIR=$(top_srcdir)/gst
  11
  12 EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt $(DOC_MAIN_SGML_FILE)
  13
  14 HTML_DIR=$(datadir)/gstreamer/html
  15
  16 GST_LIBS += ../../gst/elements/libgstelements.la
  17
  18
  19 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  20
  21 tmpl_sources =                          \
  22         tmpl/cothreads.sgml             \
  23         tmpl/gst.sgml                   \
  24         tmpl/gstinfo.sgml               \
  25         tmpl/gstautoplug.sgml           \
  26         tmpl/gstscheduler.sgml          \
  27         tmpl/gstprops.sgml              \
  28         tmpl/gstcaps.sgml               \
  29         tmpl/gstbin.sgml                \
  30         tmpl/gstbuffer.sgml             \
  31         tmpl/gstbufferpool.sgml         \
  32         tmpl/gstdisksrc.sgml            \
  33         tmpl/gstelement.sgml            \
  34         tmpl/gstfakesink.sgml           \
  35         tmpl/gstfakesrc.sgml            \
  36         tmpl/gstfdsink.sgml             \
  37         tmpl/gstfdsrc.sgml              \
  38         tmpl/gsthttpsrc.sgml            \
  39         tmpl/gstidentity.sgml           \
  40         tmpl/gstlog.sgml                \
  41         tmpl/gstmeta.sgml               \
  42         tmpl/gstobject.sgml             \
  43         tmpl/gstpad.sgml                \
  44         tmpl/gstpipeline.sgml           \
  45         tmpl/gstplugin.sgml             \
  46         tmpl/gstqueue.sgml              \
  47         tmpl/gstreamer-unused.sgml      \
  48         tmpl/gstsinesrc.sgml            \
  49         tmpl/gsttee.sgml                \
  50         tmpl/gstthread.sgml             \
  51         tmpl/gsttrace.sgml              \
  52         tmpl/gsttype.sgml               \
  53         tmpl/gstutils.sgml              \
  54         tmpl/gstxml.sgml                \
  55         tmpl/spectrum.sgml
  56
  57 gstreamer_docdir = $(HTML_DIR)
  58 gstreamer_doc_DATA =            \
  59         gstreamer.types         \
  60         gstreamer.hierarchy     \
  61         gstreamer-sections.txt
  62
  63 SCANOBJS_FILES =                \
  64         $(DOC_MODULE).signals   \
  65         $(DOC_MODULE).hierarchy \
  66         $(DOC_MODULE).args
  67
  68 # FIXME: the dependencies here are rather broken.  Really, html/book1.html
  69 # should be rebuilt if any file in $(top_srcdir)/gst is updated.
  70 if HAVE_GTK_DOC
  71 html/book1.html: sgml/gstreamer-doc.bottom
  72         $(MAKE) html
  73 else
  74 html/book1.html:
  75 endif
  76
  77 sgml/gstreamer-doc.bottom: $(tmpl_sources)
  78         $(MAKE) sgml
  79
  80 gstreamer-decl.txt:
  81         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
  82
  83 # The LD env-var below is a nasty hack to make this work on versions of
  84 # gtkdoc-scanobj which don't understand libtool
  85 scanobj: $(srcdir)/$(DOC_MODULE).types
  86         cd ../../gst/;$(MAKE) libgst.la
  87         cd ../../gst/elements/;$(MAKE) libgstelements.la
  88         rm gstreamer-scan.o; ln -s gstreamer-scan.lo gstreamer-scan.o
  89         env CC="$(LIBTOOL) $(CC)" LD="cp gstreamer-scan.lo gstreamer-scan.o;$(LIBTOOL) $(CC)" CFLAGS="$(LIBGST_CFLAGS) $(GLIB_CFLAGS) $(XML_CFLAGS) -I../../" LDFLAGS="$(GST_LIBS)"\
  90         gtkdoc-scanobj --module=$(DOC_MODULE)
  91         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
  92
  93 tmpl: scanobj gstreamer-decl.txt
  94         gtkdoc-mktmpl --module=$(DOC_MODULE)
  95
  96 sgml: tmpl
  97         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
  98
  99 html: sgml
 100         if ! test -d html ; then mkdir html ; fi
 101         -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 102
 103 clean-local:
 104         rm -rf *~ *.bak *.signals *-unused.txt *.args *.o *.lo .libs sgml html
 105
 106 distclean-local: clean
 107         rm -rf $(DOC_MODULE)-decl-list.txt
 108
 109 install-data-local: html/book1.html
 110         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 111         (installfiles=`echo $(srcdir)/html/*.html`; \
 112         if test "$$installfiles" = '$(srcdir)/html/*.html'; \
 113         then echo '-- Nothing to install' ; \
 114         else \
 115           for i in $$installfiles; do \
 116             echo '-- Installing '$$i ; \
 117             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 118           done; \
 119           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 120           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 121           echo '-- Fixing Crossreferences' ; \
 122           gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
 123         fi)
 124
 125 dist-hook: html/book1.html
 126         if ! test -d $(distdir)/tmpl ; then mkdir $(distdir)/tmpl ; fi
 127         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 128
 129 .PHONY : html sgml tmpl