Intégration avec autoconf

C'est très simple ! Il faut juste ajouter une ligne dans votre script configure.ac.

Exemple II.2 Intégration avec autoconf
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

          

Cela impose à tous les développeurs d'installer gtk-doc. Si pour votre projet, vous pouvez avoir une configuration de construction api-doc optionnelle, vous pouvez résoudre ce problème comme ci-dessous. Ne le modifiez pas car gtkdocize recherche GTK_DOC_CHECK au début d'une ligne.

Exemple II.3 Laisser gtk-doc optionnel
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])

          

Le premier argument est utilisé pour vérifier le paramètre gtkdocversion au moment de la configuration. Le second, en option, est utilisé par gtkdocize. La macro GTK_DOC_CHECK ajoute également plusieurs drapeaux de configuration :

  1. --with-html-dir=CHEMIN : répertoire d'installation de la documentation,
  2. --enable-gtk-doc : utilisation de gtk-doc pour construire la documentation [par défaut=no],
  3. --enable-gtk-doc-html : construction de la documentation au format html [par défaut=yes],
  4. --enable-gtk-doc-pdf : construction de la documentation au format pdf [par défaut=no].

GTK-Doc est désactivé par défaut ! N'oubliez pas de passer l'option '--enable-gtk-doc' lors de la prochaine exécution du script configure. Dans le cas contraire, la documentation pré-générée est installée (ce qui a du sens pour les utilisateurs mais pas pour les développeurs).

De plus, il est recommandé d'avoir la ligne suivante dans votre script configure.ac. Cela permet à gtkdocize de copier automatiquement les définitions de macro pour GTK_DOC_CHECK à votre projet.

Exemple II.4 Préparation pour gtkdocize
AC_CONFIG_MACRO_DIR(m4)