doc/reference/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=$(PACKAGE)
  13
  14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  15 #DOC_MODULE_VERSION=2
  16
  17
  18 # The top-level SGML file. You can change this if you want to.
  19 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  20
  21 # Directories containing the source code.
  22 # gtk-doc will search all .c and .h files beneath these paths
  23 # for inline comments documenting functions and macros.
  24 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  25 DOC_SOURCE_DIR=../../lib
  26
  27 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  28 SCANGOBJ_OPTIONS=
  29
  30 # Extra options to supply to gtkdoc-scan.
  31 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  32 SCAN_OPTIONS=--ignore-decorators=ASN1_API \
  33         --deprecated-guards=ASN1_DISABLE_DEPRECATED
  34
  35 # Extra options to supply to gtkdoc-mkdb.
  36 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  37 MKDB_OPTIONS=--xml-mode --output-format=xml
  38
  39 # Extra options to supply to gtkdoc-mktmpl
  40 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  41 MKTMPL_OPTIONS=
  42
  43 # Extra options to supply to gtkdoc-mkhtml
  44 MKHTML_OPTIONS=
  45
  46 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  47 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  48 FIXXREF_OPTIONS=
  49
  50 -include $(top_srcdir)/doc/doc.mk
  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=$(HEADER_FILES)
  56 CFILE_GLOB=$(C_SOURCE_FILES)
  57
  58 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  59 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  60 EXTRA_HFILES=
  61
  62 # Header files or dirs to ignore when scanning. Use base file/dir names
  63 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  64 IGNORE_HFILES=
  65
  66 # find lib -name \*.h -exec basename {} \; | grep -v -e ^abstract.h$ -e ^crypto.h$ -e ^dtls.h$ -e ^gnutls.h$ -e ^openpgp.h$ -e ^pkcs11.h$ -e ^pkcs12.h$ -e ^x509.h$ -e ^ocsp.h$  -e ^tpm.h$ | sort | uniq | sed -e 's/^/\t/' -e 's/$/ \\/'
  67 IGNORE_HFILES += $(top_srcdir)/lib/*.h $(top_srcdir)/lib/*/*.h $(top_srcdir)/libdane/*.h
  68
  69 # Images to copy into HTML directory.
  70 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  71 HTML_IMAGES=
  72
  73 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  74 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  75 content_files=
  76
  77 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  78 # These files must be listed here *and* in content_files
  79 # e.g. expand_content_files=running.sgml
  80 expand_content_files=
  81
  82 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  83 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  84 # signals and properties.
  85 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  86 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  87 GTKDOC_CFLAGS=
  88 GTKDOC_LIBS=
  89
  90 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  91 include $(top_srcdir)/gtk-doc.make
  92
  93 # Other files to distribute
  94 # e.g. EXTRA_DIST += version.xml.in
  95 EXTRA_DIST +=
  96
  97 # Files not to distribute
  98 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
  99 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 100 #DISTCLEANFILES +=
 101
 102 # Comment this out if you want 'make check' to test you doc status
 103 # and run some sanity checks
 104 if ENABLE_GTK_DOC
 105 TESTS_ENVIRONMENT = cd $(srcdir) && \
 106   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
 107   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
 108 #TESTS = $(GTKDOC_CHECK)
 109 endif
 110
 111 -include $(top_srcdir)/git.mk