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 MKHTML_OPTIONS =
  37
  38 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  39 FIXXREF_OPTIONS =
  40
  41 # Used for dependencies. The docs will be rebuilt if any of these change.
  42 HFILE_GLOB = $(top_srcdir)/libchimara/*.h
  43 CFILE_GLOB = $(top_srcdir)/libchimara/*.c
  44
  45 # Extra headers to include when scanning, which are not under DOC_SOURCE_DIR
  46 EXTRA_HFILES =
  47
  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
  51
  52 # Images to copy into HTML directory.
  53 HTML_IMAGES = \
  54         $(srcdir)/images/fig1.png \
  55         $(srcdir)/images/fig2.png \
  56         $(srcdir)/images/fig3a.png \
  57         $(srcdir)/images/fig3b.png \
  58         $(srcdir)/images/fig3c.png \
  59         $(srcdir)/images/fig4a.png \
  60         $(srcdir)/images/fig4b.png \
  61         $(srcdir)/images/fig4c.png \
  62         $(srcdir)/images/fig5-7a.png \
  63         $(srcdir)/images/fig6.png \
  64         $(srcdir)/images/fig7b.png \
  65         $(srcdir)/images/fig7c.png \
  66         $(srcdir)/images/fig7d.png \
  67         $(srcdir)/images/fig7e.png \
  68         $(srcdir)/images/fig8a.png \
  69         $(srcdir)/images/fig8b.png \
  70         $(srcdir)/images/fig8c.png \
  71         $(srcdir)/images/fig9.png \
  72         $(srcdir)/images/fig10.png \
  73         $(srcdir)/images/fig11.png
  74
  75 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  76 content_files = version.xml \
  77         selectors.xml \
  78         glk-front-matter.sgml \
  79         glk-introduction.sgml \
  80         glk-main-function.sgml \
  81         glk-api-conventions.sgml \
  82         glk-character-encoding.sgml \
  83         glk-output.sgml \
  84         glk-line-input.sgml \
  85         glk-windows.sgml \
  86         glk-window-arrangement.sgml \
  87         glk-display-style.sgml \
  88         glk-other-events.sgml \
  89         glk-porting.sgml \
  90         dispatch.sgml \
  91         blorb.sgml \
  92         blorb-library.sgml
  93
  94 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
  95 # These files must be listed here *and* in content_files
  96 expand_content_files = \
  97         glk-main-function.sgml \
  98         glk-api-conventions.sgml \
  99         glk-output.sgml \
 100         glk-line-input.sgml \
 101         glk-window-arrangement.sgml \
 102         glk-display-style.sgml \
 103         glk-other-events.sgml
 104
 105 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 106 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
 107 # signals and properties.
 108 GTKDOC_CFLAGS = -I$(top_srcdir) $(CHIMARA_CFLAGS)
 109 GTKDOC_LIBS =  $(top_builddir)/libchimara/libchimara.la
 110
 111 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 112 include $(top_srcdir)/gtk-doc.make
 113
 114 # Other files to distribute
 115 EXTRA_DIST += version.xml.in
 116
 117 # Files not to distribute
 118 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 119 # for --rebuild-sections in $(SCAN_OPTIONS), e.g. $(DOC_MODULE)-sections.txt
 120 CLEANFILES += selectors.xml
 121 DISTCLEANFILES = version.xml $(DOC_MODULE)-overrides.txt
 122
 123 # Uncomment this if you want your docs-status tested during 'make check'
 124 # Comment this while not all symbols are documented, otherwise distcheck fails
 125 #if ENABLE_GTK_DOC
 126 #TESTS_ENVIRONMENT = cd $(srcdir) &&
 127 #TESTS = $(GTKDOC_CHECK)
 128 #endif
 129
 130 dist_noinst_SCRIPTS = build-selector-table.pl
 131
 132 selectors.xml: $(srcdir)/../../libchimara/gi_dispa.c
 133         $(PERL) build-selector-table.pl $< > $@
 134