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=gsignond
  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=$(top_srcdir)/include\
  26 $(top_srcdir)/src/common\
  27 $(top_srcdir)/src/plugins
  28
  29 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  30 SCANGOBJ_OPTIONS=
  31
  32 # Extra options to supply to gtkdoc-scan.
  33 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  34 SCAN_OPTIONS=
  35
  36 # Extra options to supply to gtkdoc-mkdb.
  37 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  38 MKDB_OPTIONS=--xml-mode --output-format=xml
  39
  40 # Extra options to supply to gtkdoc-mktmpl
  41 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  42 MKTMPL_OPTIONS=
  43
  44 # Extra options to supply to gtkdoc-mkhtml
  45 MKHTML_OPTIONS=
  46
  47 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  48 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  49 FIXXREF_OPTIONS=
  50
  51 # Used for dependencies. The docs will be rebuilt if any of these change.
  52 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  53 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  54 HFILE_GLOB=
  55 CFILE_GLOB=
  56
  57 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  58 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  59 EXTRA_HFILES=
  60
  61 # Header files or dirs to ignore when scanning. Use base file/dir names
  62 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  63 IGNORE_HFILES=\
  64 gsignond-disposable.h\
  65 gsignond-identity-info.h\
  66 gsignond-identity-info-internal.h\
  67 gsignond-pipe-stream.h\
  68 gsignond-plugin-enum-types.h\
  69 gsignond-plugin-loader.h\
  70 gsignond-db-defines.h\
  71 gsignond-db-error.h\
  72 gsignond-db-secret-database.h\
  73 gsignond-db-sql-database.h\
  74 gsignond-db-sql-database-private.h
  75
  76 # Images to copy into HTML directory.
  77 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  78 HTML_IMAGES=
  79
  80 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  81 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  82 content_files=building.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
  96 GTKDOC_LIBS=\
  97     $(top_builddir)/src/common/libgsignond-common.la\
  98     $(top_builddir)/src/plugins/digest/libdigest.la\
  99     $(top_builddir)/src/plugins/password/libpassword.la\
 100     $(top_builddir)/src/plugins/ssotest/libssotest.la
 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 +=
 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 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