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.
Ce paquet est connu pour se construire correctement sur une
plateforme LFS-9.0.
Informations sur le paquet
Dépendances de GTK-Doc
Requises
docbook-xml-4.5, docbook-xsl-1.79.2, itstool-2.0.6
et libxslt-1.1.33
Recommandées
Pygments-2.4.2 à l'exécution
Facultatives
Pour les tests : dblatex ou fop-2.3 (prise en
charge du PDF par XML), GLib-2.60.6, Which-2.21 et les modules
Python lxml-4.4.1, anytree et
paramerterized
![[Note]](../images/note.png)
Note
Les modules python facultatifs ci-dessus peuvent être facilement
installés avec la commande pip3.
Notes utilisateur : http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc
Installation de GTK-Doc
Installez GTK-Doc en lançant les
commandes suivantes :
./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.