Make vte dual buildable with gtk2 and gtk3
[vte.git] / doc / reference / 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 = vte
11
12 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
13 DOC_MODULE_VERSION = $(VTE_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 # documenting the functions and macros.
21 # e.g. DOC_SOURCE_DIR=../../../gtk
22 DOC_SOURCE_DIR = ../../src
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 = --deprecated-guards="VTE_DISABLE_DEPRECATED"
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=vte
34
35 # Extra options to supply to gtkdoc-mktmpl
36 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
37 MKTMPL_OPTIONS =
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)/src/*.h \
57         $(top_builddir)/src/*.h
58
59 CFILE_GLOB = \
60         $(top_srcdir)/src/*.c
61
62 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
63 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
64 # EXTRA_HFILES = $(top_builddir)/vte/vteversion.h
65 EXTRA_HFILES =
66
67 # Header files to ignore when scanning. Use base file name, no paths
68 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
69 IGNORE_HFILES = \
70         config.h \
71         buffer.h \
72         caps.h \
73         debug.h \
74         iso2022.h \
75         keymap.h \
76         marshal.h \
77         matcher.h \
78         ring.h \
79         stamp-vtetypebuiltins.h \
80         table.h \
81         trie.h \
82         vtebg.h \
83         vteconv.h \
84         vtedraw.h \
85         vteint.h \
86         vte-private.h \
87         vteregex.h \
88         vterowdata.h \
89         vteseq-list.h \
90         vtestream-base.h \
91         vtestream-file.h \
92         vtestream.h \
93         vtetc.h \
94         vtetree.h \
95         vteunistr.h \
96         vteunistr.h
97
98 # Images to copy into HTML directory.
99 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
100 HTML_IMAGES =
101
102 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
103 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
104 content_files = \
105         version.xml
106
107 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
108 # These files must be listed here *and* in content_files
109 # e.g. expand_content_files=running.sgml
110 expand_content_files =
111
112 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
113 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
114 # signals and properties.
115 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
116 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
117 GTKDOC_CFLAGS = \
118         -I$(top_srcdir) \
119         -I$(top_srcdir)/src \
120         -I$(top_builddir) \
121         -I$(top_builddir)/src \
122         -DVTE_COMPILATION \
123         $(VTE_CFLAGS)
124
125 GTKDOC_LIBS = \
126         $(top_builddir)/src/libvte@VTE_LIBRARY_SUFFIX_U@.la \
127         $(VTE_LIBS)
128
129 # This includes the standard gtk-doc make rules, copied by gtkdocize.
130 include $(top_srcdir)/gtk-doc.make
131
132 # Other files to distribute
133 # e.g. EXTRA_DIST += version.xml.in
134 EXTRA_DIST += \
135         version.xml.in
136
137 # Files not to distribute
138 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
139 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
140 #DISTCLEANFILES +=
141
142 # Comment this out if you want your docs-status tested during 'make check'
143 #if ENABLE_GTK_DOC
144 #TESTS_ENVIRONMENT = cd $(srcsrc) &&
145 #TESTS = $(GTKDOC_CHECK)
146 #endif
147
148 -include $(top_srcdir)/git.mk