]> www.fi.muni.cz Git - evince.git/blob - help/reference/shell/Makefile.am
[docs] Modernise API docs
[evince.git] / help / reference / shell / Makefile.am
1 # We require automake 1.10 for $(abs_builddir)
2 AUTOMAKE_OPTIONS = 1.10
3
4 # This is a blank Makefile.am for using gtk-doc.
5 # Copy this to your project's API docs directory and modify the variables to
6 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
7 # of using the various options.
8
9 # The name of the module, e.g. 'glib'.
10 DOC_MODULE = evince
11
12 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
13 # DOC_MODULE_VERSION = $(EV_API_VERSION)
14
15 # The top-level SGML file. You can change this if you want to.
16 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
17
18 # The directory containing the source code. Relative to $(srcdir).
19 # gtk-doc will search all .c & .h files beneath here for inline comments
20 # evinceing the functions and macros.
21 # e.g. DOC_SOURCE_DIR=../../../gtk
22 DOC_SOURCE_DIR = ../../../shell --source-dir=../../../libmisc
23
24 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
25 SCANGOBJ_OPTIONS =
26
27 # Extra options to supply to gtkdoc-scan.
28 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
29 SCAN_OPTIONS =
30
31 # Extra options to supply to gtkdoc-mkdb.
32 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
33 MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=ev
34
35 # Extra options to supply to gtkdoc-mktmpl
36 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
37 MKTMPL_OPTIONS =--source-dir=../../../libmisc
38
39 # Extra options to supply to gtkdoc-mkhtml
40 # Add the builddir to the HTML path so that version.xml is found
41 MKHTML_OPTIONS = --path="$(abs_builddir)"
42
43 # Extra options to supply to gtkdoc-fixref. Not normally needed.
44 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
45 FIXXREF_OPTIONS = \
46         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
47         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
48         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
49         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
50         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk
51
52 # Used for dependencies. The docs will be rebuilt if any of these change.
53 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
54 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
55 HFILE_GLOB = \
56         $(top_srcdir)/shell/*.h \
57         $(top_builddir)/shell/*.h \
58         $(top_srcdir)/libmisc/*.h \
59         $(top_builddir)/libmisc/*.h
60
61 CFILE_GLOB = \
62         $(top_srcdir)/shell/*.c \
63         $(top_srcdir)/libmisc/*.c
64
65 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
66 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
67 # EXTRA_HFILES = $(top_builddir)/evince/ev-version.h
68 EXTRA_HFILES =
69
70 # Header files to ignore when scanning. Use base file name, no paths
71 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
72 IGNORE_HFILES = \
73         config.h \
74         ev-marshal.h \
75         ev-application-service.h \
76         ev-daemon-service.h
77
78 # Images to copy into HTML directory.
79 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
80 HTML_IMAGES =
81
82 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
83 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
84 content_files = \
85         version.xml
86
87 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
88 # These files must be listed here *and* in content_files
89 # e.g. expand_content_files=running.sgml
90 expand_content_files =
91
92 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
93 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
94 # signals and properties.
95 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
96 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
97 GTKDOC_CFLAGS = \
98         -I$(top_srcdir)                                 \
99         -I$(top_builddir)                               \
100         -I$(top_srcdir)/shell                           \
101         -I$(top_builddir)/shell                         \
102         -I$(top_srcdir)/cut-n-paste/zoom-control/       \
103         -I$(top_srcdir)/cut-n-paste/toolbar-editor/     \
104         -I$(top_srcdir)/cut-n-paste/totem-screensaver/  \
105         -I$(top_srcdir)/libdocument                     \
106         -I$(top_builddir)/libdocument                   \
107         -I$(top_srcdir)/libview                         \
108         -I$(top_srcdir)/libmisc                         \
109         -I$(top_builddir)/libview                       \
110         -I$(top_srcdir)/properties                      \
111         -DDATADIR=\"$(pkgdatadir)\"                     \
112         -DGNOMEDATADIR=\"$(datadir)\"                   \
113         -DGNOMELOCALEDIR=\"$(datadir)/locale\"          \
114         -DGNOMEICONDIR=\""$(datadir)/pixmaps"\"         \
115         -DEVINCE_COMPILATION                            \
116         $(SHELL_CFLAGS)                                 \
117         $(WARN_CFLAGS)                                  \
118         $(DISABLE_DEPRECATED)                           \
119         $(GTK_PRINT_CFLAGS)
120
121 FILTER_OUT = \
122         $(top_builddir)/shell/main.o                    \
123         $(top_builddir)/shell/evinced-ev-daemon.o       \
124         $(top_builddir)/shell/ev-convert-metadata.o
125
126 GTKDOC_LIBS = \
127         $(top_builddir)/cut-n-paste/zoom-control/libephyzoom.la         \
128         $(top_builddir)/cut-n-paste/toolbar-editor/libtoolbareditor.la  \
129         $(top_builddir)/cut-n-paste/totem-screensaver/libtotemscrsaver.la       \
130         $(top_builddir)/cut-n-paste/evinfobar/libevinfobar.la           \
131         $(top_builddir)/cut-n-paste/gimpcellrenderertoggle/libgimpcellrenderertoggle.la \
132         $(top_builddir)/cut-n-paste/smclient/libsmclient.la             \
133         $(top_builddir)/properties/libevproperties.la                   \
134         $(top_builddir)/libdocument/libevdocument.la                    \
135         $(top_builddir)/libview/libevview.la                            \
136         $(top_builddir)/libmisc/libevmisc.la                            \
137         $(SHELL_LIBS)                                                   \
138         $(GTK_PRINT_LIBS)                                               \
139         $(filter-out $(FILTER_OUT),$(wildcard $(top_builddir)/shell/*.o))
140
141 # This includes the standard gtk-doc make rules, copied by gtkdocize.
142 include $(top_srcdir)/gtk-doc.make
143
144 # Other files to distribute
145 # e.g. EXTRA_DIST += version.xml.in
146 EXTRA_DIST += \
147         version.xml.in
148
149 # Files not to distribute
150 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
151 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
152 #DISTCLEANFILES +=
153
154 # Comment this out if you want your docs-status tested during 'make check'
155 if ENABLE_GTK_DOC
156 #TESTS_ENVIRONMENT = cd $(srcsrc) &&
157 #TESTS = $(GTKDOC_CHECK)
158 endif
159
160 -include $(top_srcdir)/git.mk