Integration with autoconf

Very easy! Just add one line to your script.

Example 2-2Integration with autoconf
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

This will require all developers to have gtk-doc installed. If it is okay for your project to have optional api-doc build setup, you can solve this as below. Keep it as is, as gtkdocize is looking for GTK_DOC_CHECK at the start of a line.

Example 2-3Keep gtk-doc optional
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

The first argument is used to check for the gtkdocversion at configure time. The 2nd, optional argument is used by gtkdocize. The GTK_DOC_CHECK macro also adds several configure switches:

  1. --with-html-dir=PATH : path to installed docs
  2. --enable-gtk-doc : use gtk-doc to build documentation [default=no]
  3. --enable-gtk-doc-html : build documentation in html format [default=yes]
  4. --enable-gtk-doc-pdf : build documentation in pdf format [default=no]

GTK-Doc is disabled by default! Remember to pass the option '--enable-gtk-doc' to the next configure run. Otherwise pregenerated documentation is installed (which makes sense for users but not for developers).

Furthermore it is recommended that you have the following line inside your script. This allows gtkdocize to automatically copy the macro definition for GTK_DOC_CHECK to your project.

Example 2-4Preparation for gtkdocize

After all changes to are made, update the configure file. This can be done by re-running autoreconf -i or