1
## Process this file with automake to produce Makefile.in
3
# This is a blank Makefile.am for using gtk-doc.
4
# Copy this to your project's API docs directory and modify the variables to
5
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
6
# of using the various options.
8
# The name of the module, e.g. 'glib'.
11
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
15
# The top-level SGML file. You can change this if you want to.
16
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
18
# Directories containing the source code, relative to $(srcdir).
19
# gtk-doc will search all .c and .h files beneath these paths
20
# for inline comments documenting functions and macros.
21
# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
22
DOC_SOURCE_DIR=$(top_srcdir)/src
24
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
27
# Extra options to supply to gtkdoc-scan.
28
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
29
#SCAN_OPTIONS=--rebuild-types
32
# Extra options to supply to gtkdoc-mkdb.
33
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
34
MKDB_OPTIONS=--xml-mode --output-format=xml
36
# Extra options to supply to gtkdoc-mktmpl
37
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
40
# Extra options to supply to gtkdoc-mkhtml
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
47
# Used for dependencies. The docs will be rebuilt if any of these change.
48
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
49
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
50
HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
51
CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
53
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
54
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
57
# Header files or dirs to ignore when scanning. Use base file/dir names
58
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
61
# Images to copy into HTML directory.
62
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
65
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
66
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
69
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
70
# These files must be listed here *and* in content_files
71
# e.g. expand_content_files=running.sgml
74
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
75
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
76
# signals and properties.
77
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
78
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
79
GTKDOC_CFLAGS=$(GTK_CFLAGS)
80
GTKDOC_LIBS=$(top_builddir)/src/libgrip.la $(GTK_LIBS)
82
# This includes the standard gtk-doc make rules, copied by gtkdocize.
83
include $(top_srcdir)/gtk-doc.make
85
# Other files to distribute
86
# e.g. EXTRA_DIST += version.xml.in
87
EXTRA_DIST += libgrip-docs.sgml.in
89
# Files not to distribute
90
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
91
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
94
# Comment this out if you want 'make check' to test you doc status
95
# and run some sanity checks
97
TESTS_ENVIRONMENT = cd $(srcdir) && \
98
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
99
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
100
#TESTS = $(GTKDOC_CHECK)
103
dist-hook-local: gtk-docs-clean all-local
105
gtk-docs-clean: clean
added
removed
doc/reference/Makefile.am
