sergiotarxz/libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update gtk-doc Makefile.am

Browse Source 
"make check" now works in docs
This commit is contained in:
John Cupitt 2014-12-12 15:51:07 +00:00
parent 195fb15f5e
commit 7f34722f9f
6 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -39,6 +39,7 @@ depcomp
autom4te.cache/ autom4te.cache/
doc/reference/gtk-doc.make doc/reference/gtk-doc.make
doc/reference/libvips-docs.sgml doc/reference/libvips-docs.sgml
doc/reference/libvips-docs.xml
install-sh install-sh
libtool libtool
libvips/include/vips/version.h libvips/include/vips/version.h

2
bootstrap.sh
View File

@ -15,7 +15,7 @@ rm -f swig/vipsCC/VImage.py python/vipsCC/VError.py python/vipsCC/VMask.py pytho
rm -f benchmark/temp* rm -f benchmark/temp*
( cd doc ; \ ( cd doc ; \
mkdir poop ; \ mkdir poop ; \
mv reference/libvips-docs.sgml.in poop ; \ mv reference/libvips-docs.xml.in poop ; \
mv reference/Makefile.am poop ; \ mv reference/Makefile.am poop ; \
mv reference/images poop ; \ mv reference/images poop ; \
mv reference/*.xml poop ; \ mv reference/*.xml poop ; \

2
configure.ac
View File

@ -847,7 +847,7 @@ AC_OUTPUT([
man/Makefile man/Makefile
doc/Makefile doc/Makefile
doc/reference/Makefile doc/reference/Makefile
doc/reference/libvips-docs.sgml doc/reference/libvips-docs.xml
po/Makefile.in po/Makefile.in
]) ])

41
doc/reference/Makefile.am
View File

@ -9,20 +9,19 @@ AUTOMAKE_OPTIONS = 1.6
# of using the various options. # of using the various options.
# The name of the module, e.g. 'glib'. # The name of the module, e.g. 'glib'.
# (vips: we put the version in the module name rather than defining
# DOC_MODULE_VERSION to avoid some broken links)
DOC_MODULE=libvips DOC_MODULE=libvips
# Uncomment for versioned docs and specify the version of the module, e.g. '2'. # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
#DOC_MODULE_VERSION=7 #DOC_MODULE_VERSION=2
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(srcdir). # The top-level XML file (SGML in the past). You can change this if you want to.
# gtk-doc will search all .c & .h files beneath here for inline comments DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk # Directories containing the source code.
# gtk-doc will search all .c and .h files beneath these paths
# for inline comments documenting functions and macros.
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
DOC_SOURCE_DIR=$(top_srcdir)/libvips DOC_SOURCE_DIR=$(top_srcdir)/libvips
# Extra options to pass to gtkdoc-scangobj. Not normally needed. # Extra options to pass to gtkdoc-scangobj. Not normally needed.
@ -33,8 +32,8 @@ SCANGOBJ_OPTIONS=
SCAN_OPTIONS=--rebuild-types SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-mkdb. # Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
MKDB_OPTIONS=--sgml-mode --output-format=xml MKDB_OPTIONS=--xml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl # Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl # e.g. MKTMPL_OPTIONS=--only-section-tmpl
@ -57,11 +56,8 @@ CFILE_GLOB=$(top_srcdir)/libvips/*/*.c
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
EXTRA_HFILES= EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths # Header files or dirs to ignore when scanning. Use base file/dir names
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
# we only want to document public API, so have all .h files not in
# libvips/include in here ... and a few from libvips/include as well
IGNORE_VIPS_INCLUDE = \ IGNORE_VIPS_INCLUDE = \
almostdeprecated.h \ almostdeprecated.h \
@ -158,8 +154,6 @@ expand_content_files = \
# signals and properties. # signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
# (use VIPS_CFLAGS/VIPS_LIBS/VIPS_LIBS so we pick up the glib-object.h that
# the scanner uses)
GTKDOC_CFLAGS = @VIPS_CFLAGS@ @VIPS_INCLUDES@ GTKDOC_CFLAGS = @VIPS_CFLAGS@ @VIPS_INCLUDES@
GTKDOC_LIBS = @VIPS_CFLAGS@ ${top_builddir}/libvips/libvips.la @VIPS_LIBS@ GTKDOC_LIBS = @VIPS_CFLAGS@ ${top_builddir}/libvips/libvips.la @VIPS_LIBS@
@ -176,8 +170,13 @@ EXTRA_DIST += \
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
DISTCLEANFILES = libvips.types DISTCLEANFILES = libvips.types
# Comment this out if you want your docs-status tested during 'make check' # Comment this out if you want 'make check' to test you doc status
# and run some sanity checks
if ENABLE_GTK_DOC if ENABLE_GTK_DOC
TESTS_ENVIRONMENT = cd $(srcsrc) TESTS_ENVIRONMENT = \
TESTS = $(GTKDOC_CHECK) DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
#TESTS = $(GTKDOC_CHECK)
endif endif
-include $(top_srcdir)/git.mk

0
doc/reference/libvips-docs.sgml.in → doc/reference/libvips-docs.xml.in
View File

2
gtk-doc.make
View File

@ -1 +1 @@
/usr/share/gtk-doc/data/gtk-doc.make /usr/share/gtk-doc/data/gtk-doc.notmpl.make