help/reference/libdocument/Makefile.am

   1 # We require automake 1.10 for $(abs_builddir)
   2 AUTOMAKE_OPTIONS = 1.10
   3
   4 # This is a blank Makefile.am for using gtk-doc.
   5 # Copy this to your project's API docs directory and modify the variables to
   6 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
   7 # of using the various options.
   8
   9 # The name of the module, e.g. 'glib'.
  10 DOC_MODULE = libevdocument
  11
  12 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  13 DOC_MODULE_VERSION = $(EV_API_VERSION)
  14
  15 # The top-level SGML file. You can change this if you want to.
  16 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
  17
  18 # The directory containing the source code. Relative to $(srcdir).
  19 # gtk-doc will search all .c & .h files beneath here for inline comments
  20 # documenting the functions and macros.
  21 # e.g. DOC_SOURCE_DIR=../../../gtk
  22 DOC_SOURCE_DIR = ../../../libdocument
  23
  24 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  25 SCANGOBJ_OPTIONS =
  26
  27 # Extra options to supply to gtkdoc-scan.
  28 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  29 SCAN_OPTIONS =
  30
  31 # Extra options to supply to gtkdoc-mkdb.
  32 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  33 MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=ev
  34
  35 # Extra options to supply to gtkdoc-mktmpl
  36 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  37 MKTMPL_OPTIONS =
  38
  39 # Extra options to supply to gtkdoc-mkhtml
  40 # Add the builddir to the HTML path so that version.xml is found
  41 MKHTML_OPTIONS = --path="$(abs_builddir)"
  42
  43 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  44 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  45 FIXXREF_OPTIONS = \
  46         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
  47         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
  48         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
  49         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
  50         --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk
  51
  52 # Used for dependencies. The docs will be rebuilt if any of these change.
  53 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  54 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  55 HFILE_GLOB = \
  56         $(top_srcdir)/libdocument/*.h \
  57         $(top_builddir)/libdocument/*.h
  58
  59 CFILE_GLOB = \
  60         $(top_srcdir)/libdocument/*.c
  61
  62 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  63 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  64 # EXTRA_HFILES = $(top_builddir)/evdocument/ev-version.h
  65 EXTRA_HFILES =
  66
  67 # Header files to ignore when scanning. Use base file name, no paths
  68 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  69 IGNORE_HFILES = \
  70         config.h \
  71         ev-debug.h \
  72         ev-module.h
  73
  74 # Images to copy into HTML directory.
  75 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  76 HTML_IMAGES =
  77
  78 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  79 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  80 content_files = \
  81         version.xml
  82
  83 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  84 # These files must be listed here *and* in content_files
  85 # e.g. expand_content_files=running.sgml
  86 expand_content_files =
  87
  88 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  89 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  90 # signals and properties.
  91 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  92 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  93 GTKDOC_CFLAGS = \
  94         -I$(top_srcdir)                                 \
  95         -I$(top_builddir)                               \
  96         -I$(top_srcdir)/libdocument                     \
  97         -DEVINCEDATADIR=\"$(pkgdatadir)\"               \
  98         -DGNOMEDATADIR=\"$(datadir)\"                   \
  99         -DEVINCE_UIDIR=\"$(pkgdatadir)\"                \
 100         -DGNOMELOCALEDIR=\"$(datadir)/locale\"          \
 101         -DEV_BACKENDSDIR=\"$(backenddir)\"              \
 102         -DEVINCE_COMPILATION                            \
 103         $(AM_CFLAGS)                                    \
 104         $(LIBDOCUMENT_CFLAGS)                           \
 105         $(WARN_CFLAGS)                                  \
 106         $(DISABLE_DEPRECATED)
 107
 108 GTKDOC_LIBS = \
 109         $(top_builddir)/libdocument/libevdocument3.la   \
 110         $(LIBDOCUMENT_LIBS)
 111
 112 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 113 include $(top_srcdir)/gtk-doc.make
 114
 115 # Other files to distribute
 116 # e.g. EXTRA_DIST += version.xml.in
 117 EXTRA_DIST += \
 118         version.xml.in
 119
 120 # Files not to distribute
 121 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 122 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 123 #DISTCLEANFILES +=
 124
 125 # Comment this out if you want your docs-status tested during 'make check'
 126 if ENABLE_GTK_DOC
 127 #TESTS_ENVIRONMENT = cd $(srcsrc) &&
 128 #TESTS = $(GTKDOC_CHECK)
 129 endif
 130
 131 -include $(top_srcdir)/git.mk