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 = ../../src
  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)/src/*.h
  43 CFILE_GLOB = $(top_srcdir)/src/*.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         callbacks.h error.h
  52
  53 # Images to copy into HTML directory.
  54 HTML_IMAGES = \
  55         $(srcdir)/images/fig1.png \
  56         $(srcdir)/images/fig2.png \
  57         $(srcdir)/images/fig3a.png \
  58         $(srcdir)/images/fig3b.png \
  59         $(srcdir)/images/fig3c.png \
  60         $(srcdir)/images/fig4a.png \
  61         $(srcdir)/images/fig4b.png \
  62         $(srcdir)/images/fig4c.png \
  63         $(srcdir)/images/fig5-7a.png \
  64         $(srcdir)/images/fig6.png \
  65         $(srcdir)/images/fig7b.png \
  66         $(srcdir)/images/fig7c.png \
  67         $(srcdir)/images/fig7d.png \
  68         $(srcdir)/images/fig7e.png \
  69         $(srcdir)/images/fig8a.png \
  70         $(srcdir)/images/fig8b.png \
  71         $(srcdir)/images/fig8c.png \
  72         $(srcdir)/images/fig9.png \
  73         $(srcdir)/images/fig10.png \
  74         $(srcdir)/images/fig11.png
  75
  76 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  77 content_files = version.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
  90 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
  91 # These files must be listed here *and* in content_files
  92 expand_content_files = \
  93         glk-main-function.sgml \
  94         glk-api-conventions.sgml \
  95         glk-output.sgml \
  96         glk-line-input.sgml \
  97         glk-window-arrangement.sgml \
  98         glk-display-style.sgml \
  99         glk-other-events.sgml
 100
 101 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 102 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
 103 # signals and properties.
 104 GTKDOC_CFLAGS = -I$(top_srcdir) $(CHIMARA_CFLAGS)
 105 GTKDOC_LIBS =  $(top_builddir)/src/libchimara.la
 106
 107 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 108 include $(top_srcdir)/gtk-doc.make
 109
 110 # Other files to distribute
 111 EXTRA_DIST += version.xml.in
 112
 113 # Files not to distribute
 114 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 115 # for --rebuild-sections in $(SCAN_OPTIONS), e.g. $(DOC_MODULE)-sections.txt
 116 # DISTCLEANFILES +=
 117
 118 # Comment this out if you want your docs-status tested during 'make check'
 119 # TESTS_ENVIRONMENT = cd $(srcsrc)
 120 # TESTS = $(GTKDOC_CHECK)
 121