Introduction à GTK-Doc
Le paquet GTK-Doc permet de
documenter du code. C'est utile pour extraire des commentaires
spécialement formatés du code pour créer des documentations d'API.
Ce paquet est facultatif ; si vous ne l'installez
pas, les paquets ne construiront pas la documentation. Cela ne veut
pas dire que vous n'aurez aucune documentation. Si GTK-Doc n'est pas disponible, le processus
d'installation copiera toute la documentation pré-construite sur
votre système.
![[Note]](../images/note.png)
Note
Development versions of BLFS may not build or run some packages
properly if dependencies have been updated since the most recent
stable versions of the book.
Informations sur le paquet
Dépendances de GTK-Doc
Requises
docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7 et libxslt-1.1.35
Recommandées
Pygments-2.12.0 à l'exécution
Facultatives
Pour les tests : dblatex ou
fop-2.7
(prise en charge du PDF par XML), GLib-2.72.3, Which-2.21 et
les modules Python lxml-4.9.1, paramerterized et
yelp-tools
Note
Les modules python facultatifs ci-dessus peuvent être facilement
installés avec la commande pip3.
Notes utilisateur : https://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc
Installation de GTK-Doc
Installez GTK-Doc en exécutant les
commandes suivantes :
autoreconf -fiv &&
./configure --prefix=/usr &&
make
La suite de tests freezera si le paquet (ou une version précédente)
n'est pas déjà installé.
Maintenant, en tant qu'utilisateur root :
make install
Pour tester les résultats lancez : make check. Certains tests
échoueront en fonction des paquets facultatifs installés.