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-plugin-oauth
  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)/src
  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=
  33
  34 # Extra options to supply to gtkdoc-mkdb.
  35 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  36 MKDB_OPTIONS=--xml-mode --output-format=xml
  37
  38 # Extra options to supply to gtkdoc-mktmpl
  39 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  40 MKTMPL_OPTIONS=
  41
  42 # Extra options to supply to gtkdoc-mkhtml
  43 MKHTML_OPTIONS=
  44
  45 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  46 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  47 FIXXREF_OPTIONS=--extra-dir=../../accounts-sso.gsignond/docs/html
  48
  49 # Used for dependencies. The docs will be rebuilt if any of these change.
  50 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  51 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  52 HFILE_GLOB=
  53 CFILE_GLOB=
  54
  55 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  56 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  57 EXTRA_HFILES=
  58
  59 # Header files or dirs to ignore when scanning. Use base file/dir names
  60 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  61 IGNORE_HFILES= gsignond-oauth-plugin-oauth1.h \
  62                gsignond-oauth-plugin-oauth2.h \
  63                gsignond-oauth-plugin-utils.h
  64
  65 # Images to copy into HTML directory.
  66 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  67 HTML_IMAGES=
  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
  73 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  74 # These files must be listed here *and* in content_files
  75 # e.g. expand_content_files=running.sgml
  76 expand_content_files=
  77
  78 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  79 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  80 # signals and properties.
  81 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  82 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  83 GTKDOC_CFLAGS=\
  84     $(GSIGNON_CFLAGS) \
  85     $(LIBSOUP_CFLAGS)
  86 GTKDOC_LIBS=\
  87     $(top_builddir)/src/liboauth.la \
  88     $(GSIGNON_LIBS) \
  89     $(LIBSOUP_LIBS)
  90
  91 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  92 include $(top_srcdir)/gtk-doc.make
  93
  94 # Other files to distribute
  95 # e.g. EXTRA_DIST += version.xml.in
  96 EXTRA_DIST +=
  97
  98 # Files not to distribute
  99 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 100 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 101 #DISTCLEANFILES +=
 102
 103 # Comment this out if you want 'make check' to test you doc status
 104 # and run some sanity checks
 105 if ENABLE_GTK_DOC
 106 TESTS_ENVIRONMENT = \
 107   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
 108   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
 109 TESTS = $(GTKDOC_CHECK)
 110 endif
 111
 112 CLEANFILES += $(DOC_MODULE)-*.txt $(DOC_MODULE).types
 113