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