docs/reference/Makefile.am

   1 ### Makefile.am for Gtk-Doc directory #########################################
   2 # Adapted from examples/Makefile.am in Gtk-Doc distribution
   3
   4 # We require automake 1.6 at least.
   5 AUTOMAKE_OPTIONS = 1.6
   6
   7 # The name of the module, e.g. 'glib'.
   8 DOC_MODULE = chimara
   9
  10 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  11 # DOC_MODULE_VERSION = 2
  12
  13 # The top-level SGML file. You can change this if you want to.
  14 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
  15
  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
  20
  21 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  22 SCANGOBJ_OPTIONS =
  23
  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.
  27 SCAN_OPTIONS =
  28
  29 # Extra options to supply to gtkdoc-mkdb.
  30 MKDB_OPTIONS = --sgml-mode --output-format=xml
  31
  32 # Extra options to supply to gtkdoc-mktmpl
  33 MKTMPL_OPTIONS =
  34
  35 # Extra options to supply to gtkdoc-mkhtml
  36 # The --path is because Gtk-doc is broken on non-distcheck vpath builds! Sigh.
  37 # But it only works on Gtk-doc 1.11 and higher. So if you want to do a vpath
  38 # build then uncomment this and require 1.11 in configure.ac. If you want to do
  39 # vpath build on Debian, then you're S.O.L. Complain to Gtk-doc and Debian.
  40 # MKHTML_OPTIONS = --path="$(abs_builddir)"
  41 MKHTML_OPTIONS =
  42
  43 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  44 FIXXREF_OPTIONS =
  45
  46 # Used for dependencies. The docs will be rebuilt if any of these change.
  47 HFILE_GLOB = $(top_srcdir)/libchimara/*.h
  48 CFILE_GLOB = $(top_srcdir)/libchimara/*.c
  49
  50 # Extra headers to include when scanning, which are not under DOC_SOURCE_DIR
  51 EXTRA_HFILES =
  52
  53 # Header files to ignore when scanning. Use base file name, no paths
  54 IGNORE_HFILES = chimara-glk-private.h chimara-marshallers.h \
  55         abort.h charset.h event.h fileref.h graphics.h hyperlink.h init.h input.h \
  56         magic.h mouse.h pager.h resource.h stream.h strio.h style.h timer.h window.h
  57
  58 # Images to copy into HTML directory.
  59 HTML_IMAGES = \
  60         images/fig1.png \
  61         images/fig2.png \
  62         images/fig3a.png \
  63         images/fig3b.png \
  64         images/fig3c.png \
  65         images/fig4a.png \
  66         images/fig4b.png \
  67         images/fig4c.png \
  68         images/fig5-7a.png \
  69         images/fig6.png \
  70         images/fig7b.png \
  71         images/fig7c.png \
  72         images/fig7d.png \
  73         images/fig7e.png \
  74         images/fig8a.png \
  75         images/fig8b.png \
  76         images/fig8c.png \
  77         images/fig9.png \
  78         images/fig10.png \
  79         images/fig11.png
  80
  81 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  82 content_files = version.xml \
  83         selectors.xml \
  84         glk-front-matter.sgml \
  85         glk-introduction.sgml \
  86         glk-main-function.sgml \
  87         glk-api-conventions.sgml \
  88         glk-character-encoding.sgml \
  89         glk-output.sgml \
  90         glk-line-input.sgml \
  91         glk-windows.sgml \
  92         glk-window-arrangement.sgml \
  93         glk-display-style.sgml \
  94         glk-other-events.sgml \
  95         glk-sound-resources.sgml \
  96         glk-porting.sgml \
  97         dispatch.sgml \
  98         blorb.sgml \
  99         blorb-library.sgml
 100
 101 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
 102 # These files must be listed here *and* in content_files
 103 expand_content_files = \
 104         glk-main-function.sgml \
 105         glk-api-conventions.sgml \
 106         glk-output.sgml \
 107         glk-line-input.sgml \
 108         glk-window-arrangement.sgml \
 109         glk-display-style.sgml \
 110         glk-other-events.sgml
 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 GTKDOC_CFLAGS = -I$(top_srcdir) $(CHIMARA_CFLAGS)
 116 GTKDOC_LIBS =  $(top_builddir)/libchimara/libchimara.la
 117
 118 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 119 include $(top_srcdir)/gtk-doc.make
 120
 121 # Other files to distribute
 122 EXTRA_DIST += version.xml.in
 123
 124 # Files not to distribute
 125 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 126 # for --rebuild-sections in $(SCAN_OPTIONS), e.g. $(DOC_MODULE)-sections.txt
 127 CLEANFILES += selectors.xml
 128 DISTCLEANFILES = version.xml $(DOC_MODULE)-overrides.txt
 129
 130 # Uncomment this if you want your docs-status tested during 'make check'
 131 # Comment this while not all symbols are documented, otherwise distcheck fails
 132 #if ENABLE_GTK_DOC
 133 #TESTS_ENVIRONMENT = cd $(srcdir) &&
 134 #TESTS = $(GTKDOC_CHECK)
 135 #endif
 136
 137 dist_noinst_SCRIPTS = build-selector-table.pl
 138
 139 selectors.xml: $(srcdir)/../../libchimara/gi_dispa.c
 140         $(PERL) build-selector-table.pl $< > $@
 141