Blame docs/reference/Makefile.am

Packit 87b8d1
## Process this file with automake to produce Makefile.in
Packit 87b8d1
Packit 87b8d1
# We require automake 1.6 at least.
Packit 87b8d1
AUTOMAKE_OPTIONS = 1.6
Packit 87b8d1
Packit 87b8d1
# This is a blank Makefile.am for using gtk-doc.
Packit 87b8d1
# Copy this to your project's API docs directory and modify the variables to
Packit 87b8d1
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
Packit 87b8d1
# of using the various options.
Packit 87b8d1
Packit 87b8d1
# The name of the module, e.g. 'glib'.
Packit 87b8d1
DOC_MODULE=gfbgraph
Packit 87b8d1
Packit 87b8d1
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
Packit 87b8d1
DOC_MODULE_VERSION=@API_VERSION@
Packit 87b8d1
Packit 87b8d1
Packit 87b8d1
# The top-level XML file (SGML in the past). You can change this if you want to.
Packit 87b8d1
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
Packit 87b8d1
Packit 87b8d1
# Directories containing the source code.
Packit 87b8d1
# gtk-doc will search all .c and .h files beneath these paths
Packit 87b8d1
# for inline comments documenting functions and macros.
Packit 87b8d1
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
Packit 87b8d1
DOC_SOURCE_DIR=$(top_srcdir)/gfbgraph
Packit 87b8d1
Packit 87b8d1
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
Packit 87b8d1
SCANGOBJ_OPTIONS=
Packit 87b8d1
Packit 87b8d1
# Extra options to supply to gtkdoc-scan.
Packit 87b8d1
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
Packit 87b8d1
SCAN_OPTIONS=
Packit 87b8d1
Packit 87b8d1
# Extra options to supply to gtkdoc-mkdb.
Packit 87b8d1
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
Packit 87b8d1
MKDB_OPTIONS=--xml-mode --output-format=xml
Packit 87b8d1
Packit 87b8d1
# Extra options to supply to gtkdoc-mktmpl
Packit 87b8d1
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
Packit 87b8d1
MKTMPL_OPTIONS=
Packit 87b8d1
Packit 87b8d1
# Extra options to supply to gtkdoc-mkhtml
Packit 87b8d1
MKHTML_OPTIONS=
Packit 87b8d1
Packit 87b8d1
# Extra options to supply to gtkdoc-fixref. Not normally needed.
Packit 87b8d1
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
Packit 87b8d1
FIXXREF_OPTIONS=
Packit 87b8d1
Packit 87b8d1
# Used for dependencies. The docs will be rebuilt if any of these change.
Packit 87b8d1
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
Packit 87b8d1
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
Packit 87b8d1
HFILE_GLOB=$(top_srcdir)/gfbgraph/*.h
Packit 87b8d1
CFILE_GLOB=$(top_srcdir)/gfbgraph/*.c
Packit 87b8d1
Packit 87b8d1
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
Packit 87b8d1
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
Packit 87b8d1
EXTRA_HFILES=
Packit 87b8d1
Packit 87b8d1
# Header files or dirs to ignore when scanning. Use base file/dir names
Packit 87b8d1
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
Packit 87b8d1
IGNORE_HFILES=
Packit 87b8d1
Packit 87b8d1
# Images to copy into HTML directory.
Packit 87b8d1
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
Packit 87b8d1
HTML_IMAGES=
Packit 87b8d1
Packit 87b8d1
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
Packit 87b8d1
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
Packit 87b8d1
content_files=
Packit 87b8d1
Packit 87b8d1
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
Packit 87b8d1
# These files must be listed here *and* in content_files
Packit 87b8d1
# e.g. expand_content_files=running.sgml
Packit 87b8d1
expand_content_files=
Packit 87b8d1
Packit 87b8d1
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
Packit 87b8d1
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
Packit 87b8d1
# signals and properties.
Packit 87b8d1
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
Packit 87b8d1
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
Packit 87b8d1
GTKDOC_CFLAGS=
Packit 87b8d1
GTKDOC_LIBS=$(top_builddir)/gfbgraph/libgfbgraph-@API_VERSION@.la
Packit 87b8d1
Packit 87b8d1
# This includes the standard gtk-doc make rules, copied by gtkdocize.
Packit 87b8d1
include $(top_srcdir)/gtk-doc.make
Packit 87b8d1
Packit 87b8d1
# Other files to distribute
Packit 87b8d1
# e.g. EXTRA_DIST += version.xml.in
Packit 87b8d1
EXTRA_DIST += version.xml.in
Packit 87b8d1
Packit 87b8d1
# Files not to distribute
Packit 87b8d1
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
Packit 87b8d1
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
Packit 87b8d1
#DISTCLEANFILES +=
Packit 87b8d1
Packit 87b8d1
# Comment this out if you want 'make check' to test you doc status
Packit 87b8d1
# and run some sanity checks
Packit 87b8d1
if ENABLE_GTK_DOC
Packit 87b8d1
TESTS_ENVIRONMENT = \
Packit 87b8d1
  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
Packit 87b8d1
  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
Packit 87b8d1
#TESTS = $(GTKDOC_CHECK)
Packit 87b8d1
endif
Packit 87b8d1
Packit 87b8d1
-include $(top_srcdir)/git.mk