docs/Makefile.am

   1 # Process this file with automake to produce Makefile.in
   2
   3 # We require automake 1.6 at least.
   4 AUTOMAKE_OPTIONS = 1.6
   5
   6 # This is a blank Makefile.am for using gtk-doc.
   7 # Copy this to your project's API docs directory and modify the variables to
   8 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
   9 # of using the various options.
  10
  11 # The name of the module, e.g. 'glib'.
  12 DOC_MODULE=harfbuzz
  13
  14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  15 #DOC_MODULE_VERSION=$(HB_VERSION_MAJOR)
  16
  17 # The top-level SGML file. You can change this if you want to.
  18 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
  19
  20 # Directories containing the source code.
  21 # gtk-doc will search all .c and .h files beneath these paths
  22 # for inline comments documenting functions and macros.
  23 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  24 DOC_SOURCE_DIR=$(top_srcdir)/src $(top_builddir)/src
  25
  26 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  27 SCANGOBJ_OPTIONS=
  28
  29 # Extra options to supply to gtkdoc-scan.
  30 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  31 SCAN_OPTIONS=--rebuild-types --deprecated-guards="HB_DISABLE_DEPRECATED" \
  32         --ignore-decorators='HB_EXTERN|HB_DEPRECATED'
  33
  34 # Header files or dirs to ignore when scanning. Use base file/dir names
  35 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  36 IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './*/*.h' | sed 's@^.*/@@'`
  37 IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
  38
  39 # Extra options to supply to gtkdoc-mkdb.
  40 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  41 MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
  42
  43 # Extra options to supply to gtkdoc-mktmpl
  44 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  45 MKTMPL_OPTIONS=
  46
  47 # Extra options to supply to gtkdoc-mkhtml
  48 MKHTML_OPTIONS=
  49
  50 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  51 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  52 FIXXREF_OPTIONS=
  53
  54 # Used for dependencies. The docs will be rebuilt if any of these change.
  55 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  56 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  57 HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
  58 CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
  59
  60 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  61 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  62
  63 # Images to copy into HTML directory.
  64 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  65 HTML_IMAGES=  \
  66         HarfBuzz.png \
  67         HarfBuzz.svg
  68
  69 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  70 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  71 content_files=  \
  72         usermanual-what-is-harfbuzz.xml \
  73         usermanual-install-harfbuzz.xml \
  74         usermanual-getting-started.xml \
  75         usermanual-glyph-information.xml \
  76         usermanual-shaping-concepts.xml \
  77         usermanual-object-model.xml \
  78         usermanual-buffers-language-script-and-direction.xml \
  79         usermanual-fonts-and-faces.xml \
  80         usermanual-opentype-features.xml \
  81         usermanual-clusters.xml \
  82         usermanual-utilities.xml \
  83         usermanual-integration.xml \
  84         version.xml
  85
  86 # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
  87 # These files must be listed here *and* in content_files
  88 # e.g. expand_content_files=running.sgml
  89 expand_content_files=
  90
  91 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  92 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  93 # signals and properties.
  94 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  95 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  96 GTKDOC_CFLAGS=
  97 GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
  98 if HAVE_GOBJECT
  99 GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
 100 endif
 101
 102 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 103 include $(top_srcdir)/gtk-doc.make
 104
 105 # Other files to distribute
 106 # e.g. EXTRA_DIST += version.xml.in
 107 EXTRA_DIST += version.xml.in meson.build
 108
 109 # Files not to distribute
 110 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 111 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 112 #DISTCLEANFILES +=
 113
 114 # Comment this out if you don't want 'make check' to test you doc status
 115 # and run some sanity checks
 116 if ENABLE_GTK_DOC
 117 TESTS_ENVIRONMENT = cd $(srcdir) && \
 118   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
 119   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
 120 #TESTS = $(GTKDOC_CHECK)
 121 endif
 122
 123 -include $(top_srcdir)/git.mk