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 = ../../libchimara
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
36 # The --path is because Gtk-doc is broken on non-distcheck vpath builds! Sigh.
37 MKHTML_OPTIONS = --path="$(abs_builddir)"
39 # Extra options to supply to gtkdoc-fixref. Not normally needed.
42 # Used for dependencies. The docs will be rebuilt if any of these change.
43 HFILE_GLOB = $(top_srcdir)/libchimara/*.h
44 CFILE_GLOB = $(top_srcdir)/libchimara/*.c
46 # Extra headers to include when scanning, which are not under DOC_SOURCE_DIR
49 # Header files to ignore when scanning. Use base file name, no paths
50 IGNORE_HFILES = chimara-glk-private.h \
51 abort.h charset.h event.h input.h stream.h window.h
53 # Images to copy into HTML directory.
76 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
77 content_files = version.xml \
79 glk-front-matter.sgml \
80 glk-introduction.sgml \
81 glk-main-function.sgml \
82 glk-api-conventions.sgml \
83 glk-character-encoding.sgml \
87 glk-window-arrangement.sgml \
88 glk-display-style.sgml \
89 glk-other-events.sgml \
95 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
96 # These files must be listed here *and* in content_files
97 expand_content_files = \
98 glk-main-function.sgml \
99 glk-api-conventions.sgml \
101 glk-line-input.sgml \
102 glk-window-arrangement.sgml \
103 glk-display-style.sgml \
104 glk-other-events.sgml
106 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
107 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
108 # signals and properties.
109 GTKDOC_CFLAGS = -I$(top_srcdir) $(CHIMARA_CFLAGS)
110 GTKDOC_LIBS = $(top_builddir)/libchimara/libchimara.la
112 # This includes the standard gtk-doc make rules, copied by gtkdocize.
113 include $(top_srcdir)/gtk-doc.make
115 # Other files to distribute
116 EXTRA_DIST += version.xml.in
118 # Files not to distribute
119 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
120 # for --rebuild-sections in $(SCAN_OPTIONS), e.g. $(DOC_MODULE)-sections.txt
121 CLEANFILES += selectors.xml
122 DISTCLEANFILES = version.xml $(DOC_MODULE)-overrides.txt
124 # Uncomment this if you want your docs-status tested during 'make check'
125 # Comment this while not all symbols are documented, otherwise distcheck fails
127 #TESTS_ENVIRONMENT = cd $(srcdir) &&
128 #TESTS = $(GTKDOC_CHECK)
131 dist_noinst_SCRIPTS = build-selector-table.pl
133 selectors.xml: $(srcdir)/../../libchimara/gi_dispa.c
134 $(PERL) build-selector-table.pl $< > $@