docs/reference/Makefile.am
author ali <ali@juiblex.co.uk>
Wed Oct 10 22:58:21 2012 +0100 (2012-10-10)
changeset 0 bc8c9a11cbfc
permissions -rw-r--r--
Initial version
ali@0
     1
## Process this file with automake to produce Makefile.in
ali@0
     2
ali@0
     3
# We require automake 1.6 at least.
ali@0
     4
AUTOMAKE_OPTIONS=1.6
ali@0
     5
ali@0
     6
# This is a blank Makefile.am for using gtk-doc.
ali@0
     7
# Copy this to your project's API docs directory and modify the variables to
ali@0
     8
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
ali@0
     9
# of using the various options.
ali@0
    10
ali@0
    11
# The name of the module, e.g. 'glib'.
ali@0
    12
DOC_MODULE=libxexpr
ali@0
    13
ali@0
    14
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
ali@0
    15
#DOC_MODULE_VERSION=2
ali@0
    16
ali@0
    17
ali@0
    18
# The top-level SGML file. You can change this if you want to.
ali@0
    19
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
ali@0
    20
ali@0
    21
# The directory containing the source code. Relative to $(srcdir).
ali@0
    22
# gtk-doc will search all .c & .h files beneath here for inline comments
ali@0
    23
# documenting the functions and macros.
ali@0
    24
# e.g. DOC_SOURCE_DIR=../../../gtk
ali@0
    25
DOC_SOURCE_DIR=../../libxexpr
ali@0
    26
ali@0
    27
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
ali@0
    28
SCANGOBJ_OPTIONS=
ali@0
    29
ali@0
    30
# Extra options to supply to gtkdoc-scan.
ali@0
    31
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
ali@0
    32
SCAN_OPTIONS=--rebuild-types --rebuild-sections
ali@0
    33
ali@0
    34
# Extra options to supply to gtkdoc-mkdb.
ali@0
    35
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
ali@0
    36
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=xexpr
ali@0
    37
ali@0
    38
# Extra options to supply to gtkdoc-mktmpl
ali@0
    39
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
ali@0
    40
MKTMPL_OPTIONS=
ali@0
    41
ali@0
    42
# Extra options to supply to gtkdoc-mkhtml
ali@0
    43
MKHTML_OPTIONS=
ali@0
    44
ali@0
    45
# Extra options to supply to gtkdoc-fixref. Not normally needed.
ali@0
    46
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
ali@0
    47
FIXXREF_OPTIONS=
ali@0
    48
ali@0
    49
# Used for dependencies. The docs will be rebuilt if any of these change.
ali@0
    50
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
ali@0
    51
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
ali@0
    52
HFILE_GLOB=$(top_srcdir)/libxexpr/*.h
ali@0
    53
CFILE_GLOB=$(top_srcdir)/libxexpr/*.c
ali@0
    54
ali@0
    55
# Header files to ignore when scanning.
ali@0
    56
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
ali@0
    57
IGNORE_HFILES=xexpr.h xexprprivate.h
ali@0
    58
ali@0
    59
# Images to copy into HTML directory.
ali@0
    60
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
ali@0
    61
HTML_IMAGES=
ali@0
    62
ali@0
    63
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
ali@0
    64
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
ali@0
    65
content_files=version.xml implementation_defined_behaviour.xml \
ali@0
    66
    language_extensions.xml xexpr.xml
ali@0
    67
ali@0
    68
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
ali@0
    69
# These files must be listed here *and* in content_files
ali@0
    70
# e.g. expand_content_files=running.sgml
ali@0
    71
expand_content_files=
ali@0
    72
ali@0
    73
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
ali@0
    74
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
ali@0
    75
# signals and properties.
ali@0
    76
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
ali@0
    77
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
ali@0
    78
GTKDOC_CFLAGS=
ali@0
    79
GTKDOC_LIBS=
ali@0
    80
ali@0
    81
# This includes the standard gtk-doc make rules, copied by gtkdocize.
ali@0
    82
include $(top_srcdir)/gtk-doc.make
ali@0
    83
ali@0
    84
# Other files to distribute
ali@0
    85
# e.g. EXTRA_DIST += version.xml.in
ali@0
    86
EXTRA_DIST+=version.xml.in
ali@0
    87
ali@0
    88
# Files not to distribute
ali@0
    89
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
ali@0
    90
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
ali@0
    91
DISTCLEANFILES=$(DOC_MODULE).types $(DOC_MODULE)-sections.txt
ali@0
    92
ali@0
    93
# Comment this out if you want your docs-status tested during 'make check'
ali@0
    94
TESTS_ENVIRONMENT=cd $(srcdir) &&
ali@0
    95
TESTS=$(GTKDOC_CHECK)