Makefile.am 4.28 KB
Newer Older
Christian Persch's avatar
Christian Persch committed
1 2
# We require automake 1.10 for $(abs_builddir)
AUTOMAKE_OPTIONS = 1.10
3

Christian Persch's avatar
Christian Persch committed
4 5 6 7 8 9 10
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.

# The name of the module, e.g. 'glib'.
DOC_MODULE = rsvg
11

Christian Persch's avatar
Christian Persch committed
12 13 14
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
DOC_MODULE_VERSION = $(RSVG_API_VERSION)

15

Christian Persch's avatar
Christian Persch committed
16 17 18 19 20 21 22
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml

# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
23
DOC_SOURCE_DIR = $(abs_top_srcdir)
Christian Persch's avatar
Christian Persch committed
24 25

# Extra options to pass to gtkdoc-scangobj. Not normally needed.
26
SCANGOBJ_OPTIONS = --type-init-func="g_type_init ()"
Christian Persch's avatar
Christian Persch committed
27 28 29 30 31 32 33

# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS = --deprecated-guards="RSVG_DISABLE_DEPRECATED"

# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
34
MKDB_OPTIONS = --xml-mode --output-format=xml --name-space=rsvg
Christian Persch's avatar
Christian Persch committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48

# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS =

# Extra options to supply to gtkdoc-mkhtml
# Add the builddir to the HTML path so that version.xml is found
MKHTML_OPTIONS = --path="$(abs_builddir)"

# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS = \
	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
Christian Persch's avatar
Christian Persch committed
49
	--extra-dir=$(GDK_PIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
Christian Persch's avatar
Christian Persch committed
50 51 52 53 54 55 56
	--extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
	--extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo

# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB = \
57 58
	$(top_srcdir)/librsvg/*.h \
	$(top_builddir)/librsvg/*.h
Christian Persch's avatar
Christian Persch committed
59 60

CFILE_GLOB = \
61 62
	$(top_srcdir)/librsvg/*.c \
	$(top_builddir)/librsvg/*.c
Christian Persch's avatar
Christian Persch committed
63 64 65 66 67 68 69 70

# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
# EXTRA_HFILES = $(top_builddir)/evdocument/ev-version.h
EXTRA_HFILES =

# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
71 72
IGNORE_HFILES =			\
	config.h		\
73
	rsvg-attributes.h	\
74 75
	rsvg-css.h		\
	rsvg-private.h		\
76
	rsvg-size-callback.h
Christian Persch's avatar
Christian Persch committed
77 78 79 80 81 82 83

# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES =

# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
84 85
content_files =		\
	overview.xml	\
86
	version.xml
Christian Persch's avatar
Christian Persch committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files =

# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
GTKDOC_CFLAGS = \
	-I$(top_srcdir) \
	-I$(top_builddir) \
	$(LIBRSVG_CFLAGS) \
	$(GTK_CFLAGS) \
	$(GDK_X11_CFLAGS) \
	$(WARN_CFLAGS) \
	$(DISABLE_DEPRECATED) \
	$(AM_CFLAGS)

GTKDOC_LIBS = \
	$(top_builddir)/librsvg-@RSVG_API_MAJOR_VERSION@.la \
	$(LIBRSVG_LIBS) \
111
	$(GTHREAD_LIBS) \
Christian Persch's avatar
Christian Persch committed
112 113 114 115
	$(GTK_LIBS)

# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
116 117

# Other files to distribute
Christian Persch's avatar
Christian Persch committed
118 119 120 121 122 123 124 125 126 127 128 129 130
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST += \
	version.xml.in

# Files not to distribute
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
#DISTCLEANFILES +=

# Comment this out if you want your docs-status tested during 'make check'
if ENABLE_GTK_DOC
#TESTS_ENVIRONMENT = cd $(srcsrc) &&
#TESTS = $(GTKDOC_CHECK)
131
endif
Christian Persch's avatar
Christian Persch committed
132 133

-include $(top_srcdir)/git.mk