docs: Add overview documentation.
[profile/ivi/rygel.git] / doc / reference / doc-build.am
1 # Other Makefile.am files should set:
2 # VALA_SOURCE_FILES, VALA_SOURCE_FILES_WITH_PATHS, 
3 # RYGEL_DOCBUILD_VALADOC_FLAGS, RYGEL_DOCBUILD_MODULE
4 # and RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS
5 # and the include this .am file.
6
7 if ENABLE_VALADOC
8
9 VALADOC_FLAGS = --force \
10                 --vapidir $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE) \
11                 $(RYGEL_DOCBUILD_VALADOC_FLAGS) \
12                 --target-glib=2.32 \
13                 --vapidir=$(rygeldir) \
14                 --pkg rygel-build-config \
15                 -b $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE) \
16                 --package-name lib$(RYGEL_DOCBUILD_MODULE) \
17                 --package-version 2.0 \
18                 $(VALA_SOURCE_FILES_WITH_PATHS)
19
20
21 valadoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS)
22         $(AM_V_GEN)$(VALADOC) \
23                 -o valadoc \
24                 $(VALADOC_FLAGS)
25
26 # Avoid regeneration of the html if none of its dependencies have changed:
27 gtkdoc/html/index.html: gtkdoc-gen
28
29 RYGEL_GTKDOC_DOCS_XML = \
30         $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/lib$(RYGEL_DOCBUILD_MODULE)-docs.xml \
31         $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/overview.xml
32
33 gtkdoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS) $(RYGEL_GTKDOC_DOCS_XML)
34         @rm -rf gtkdoc/html
35         $(AM_V_GEN)$(VALADOC) \
36                 -X $(top_srcdir)/src/lib$(RYGEL_DOCBUILD_MODULE)/$(RYGEL_DOCBUILD_MODULE).h \
37                 $(RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS) \
38                 -X -l -X $(top_builddir)/src/lib$(RYGEL_DOCBUILD_MODULE)/.libs/lib$(RYGEL_DOCBUILD_MODULE)-2.0.so \
39                 -o gtkdoc \
40                 --doclet gtkdoc \
41                 $(VALADOC_FLAGS)
42                 
43 clean-local:
44         rm -rf valadoc gtkdoc/html
45         rm -f gtkdoc/html.stamp
46         rm -f gtkdoc/sgml.stamp
47         rm -rf gtkdoc/ccomments
48         rm -rf gtkdoc/xml
49         rm -rf gtkdoc/cscan
50         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).args
51         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).interfaces
52         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).hierarchy
53         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).signals
54         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).types
55         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE)*.txt
56         rm -f gtkdoc/lib$(RYGEL_DOCBUILD_MODULE).prerequisites
57
58 RYGEL_GTKDOC_INSTALL_DIR = $(DESTDIR)$(datadir)/gtk-doc/html/lib$(RYGEL_DOCBUILD_MODULE)
59
60 uninstall-hook:
61         rm -rf $(INSTALL_DIR)
62
63 all: valadoc-gen gtkdoc-gen
64
65 endif
66
67 # The chmod corrects the directory permissions so that distcheck can remove the installed files.
68 install-data-hook: gtkdoc/html/index.html
69         $(MKDIR_P) $(RYGEL_GTKDOC_INSTALL_DIR)
70         cp -d -R $(srcdir)/gtkdoc/html $(RYGEL_GTKDOC_INSTALL_DIR)
71         chmod -R u+w $(RYGEL_GTKDOC_INSTALL_DIR)
72
73
74 EXTRA_DIST = $(RYGEL_GTKDOC_DOCS_XML) gtkdoc/html valadoc
75