1 ### Makefile.am for Gtk-Doc directory #########################################
2 # Adapted from examples/Makefile.am in Gtk-Doc distribution
4 # We require automake 1.6 at least.
7 # The name of the module, e.g. 'glib'.
10 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
11 # DOC_MODULE_VERSION = 2
13 # The top-level SGML file. You can change this if you want to.
14 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
16 # The directory containing the source code. Relative to $(srcdir).
17 # gtk-doc will search all .c & .h files beneath here for inline comments
18 # documenting the functions and macros.
19 DOC_SOURCE_DIR = ../../src
21 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
24 # Extra options to supply to gtkdoc-scan.
25 # DO NOT use --rebuild-types, because it will think glk_window_get_type()
26 # is a GObject type. That makes it segfault.
29 # Extra options to supply to gtkdoc-mkdb.
30 MKDB_OPTIONS = --sgml-mode --output-format=xml
32 # Extra options to supply to gtkdoc-mktmpl
35 # Extra options to supply to gtkdoc-mkhtml
38 # Extra options to supply to gtkdoc-fixref. Not normally needed.
41 # Used for dependencies. The docs will be rebuilt if any of these change.
42 HFILE_GLOB = $(top_srcdir)/src/*.h
43 CFILE_GLOB = $(top_srcdir)/src/*.c
45 # Extra headers to include when scanning, which are not under DOC_SOURCE_DIR
48 # Header files to ignore when scanning. Use base file name, no paths
49 IGNORE_HFILES = chimara-glk-private.h \
50 abort.h charset.h event.h input.h stream.h window.h \
53 # Images to copy into HTML directory.
56 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
57 content_files = version.xml \
58 glk-front-matter.sgml \
59 glk-introduction.sgml \
60 glk-main-function.sgml \
61 glk-api-conventions.sgml \
62 glk-character-encoding.sgml \
66 glk-window-arrangement.sgml \
67 glk-display-style.sgml \
70 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
71 # These files must be listed here *and* in content_files
72 expand_content_files = \
73 glk-main-function.sgml \
74 glk-api-conventions.sgml \
77 glk-window-arrangement.sgml \
78 glk-display-style.sgml \
81 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
82 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
83 # signals and properties.
84 GTKDOC_CFLAGS = -I$(top_srcdir) $(CHIMARA_CFLAGS)
85 GTKDOC_LIBS = $(top_builddir)/src/libchimara.la
87 # This includes the standard gtk-doc make rules, copied by gtkdocize.
88 include $(top_srcdir)/gtk-doc.make
90 # Other files to distribute
91 EXTRA_DIST += version.xml.in
93 # Files not to distribute
94 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
95 # for --rebuild-sections in $(SCAN_OPTIONS), e.g. $(DOC_MODULE)-sections.txt
98 # Comment this out if you want your docs-status tested during 'make check'
99 # TESTS_ENVIRONMENT = cd $(srcsrc)
100 # TESTS = $(GTKDOC_CHECK)