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