cairo/doc/public/Makefile.am
Behdad Esfahbod d02fb0fd20 [doc/public/check-doc-coverage.sh] Make doc building needed for the test faster
We used to do a full doc build to just to run the coverage test.  That's
way too slow to expect people to run regularly.  Instead now we just do the
source code scanning part of the doc build system that is just enough to
know if all symbols are documented.

A full doc build can be done as always by invoking "make doc", and indeed
will be called as part of "make dist" or "make distcheck".
2008-09-18 15:33:10 -04:00

62 lines
1.6 KiB
Makefile

include $(top_srcdir)/build/Makefile.am.common
include $(top_srcdir)/src/Makefile.am.config
# The name of the module.
DOC_MODULE=cairo
# The top-level SGML file.
DOC_MAIN_SGML_FILE=cairo-docs.xml
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=--deprecated-guards="CAIRO_DISABLE_DEPRECATED" --ignore-decorators="cairo_public|cairo_private"
# The directory containing the source code. Relative to $(srcdir)
DOC_SOURCE_DIR=../../src
# Used for dependencies
HFILE_GLOB=$(top_srcdir)/src/cairo*.h
CFILE_GLOB=$(top_srcdir)/src/cairo*.c
# Headers to ignore
IGNORE_HFILES= \
cairo-features.h \
cairo-features-win32.h \
$(all_cairo_private) \
$(unsupported_cairo_headers) \
$(NULL)
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
MKTMPL_OPTIONS=
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
language-bindings.xml \
version.xml \
$(NULL)
version.xml: $(top_srcdir)/cairo-version.h
echo $(CAIRO_VERSION_MAJOR).$(CAIRO_VERSION_MICRO).$(CAIRO_VERSION_MINOR) > $@
# Images to copy into HTML directory
HTML_IMAGES =
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=
include $(top_srcdir)/build/Makefile.am.gtk-doc
dist-hook: doc
# This line really belongs in gtk-doc.mk
$(REPORT_FILES): sgml-build.stamp
if ENABLE_GTK_DOC
TESTS += check-doc-coverage.sh
endif
TESTS += check-doc-syntax.sh
EXTRA_DIST += check-doc-coverage.sh check-doc-syntax.sh
TESTS_ENVIRONMENT = srcdir="$(srcdir)" top_srcdir="$(top_srcdir)" MAKE="$(MAKE) $(AM_MAKEFLAGS)" DOC_MODULE="$(DOC_MODULE)" REPORT_FILES="$(REPORT_FILES)"