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 pouvoir être construit et fonctionner
correctement avec une plateform 12.2.
Informations sur le paquet
-
Téléchargement (HTTP) :
https://download.gnome.org/sources/gtk-doc/1.34/gtk-doc-1.34.0.tar.xz
-
Téléchargement (FTP) :
-
Somme de contrôle MD5 du téléchargement :
f0e7385ba25eddb6ce0953e8cf63d1bf
-
Taille du téléchargement : 484 Ko
-
Estimation de l'espace disque requis : 14 Mo (avec
les tests)
-
Estimation du temps de construction : 0,2 SBU (avec
les tests)
Dépendances de GTK-Doc
Requises
docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.80.4,
itstool-2.0.7, libxslt-1.1.42 et
Pygments-2.18.0
Facultatives
Pour les tests : dblatex ou
fop-2.9
(prise en charge du PDF par XML), GLib-2.80.4, Which-2.21 et
les modules Python lxml-5.3.0, paramerterized et
yelp-tools
![[Note]](../images/note.png)
Note
Les modules python facultatifs ci-dessus peuvent être facilement
installés avec la commande pip3.
Installation de GTK-Doc
Installez GTK-Doc en exécutant les
commandes suivantes :
mkdir -p build &&
cd build &&
meson setup --prefix=/usr --buildtype=release .. &&
ninja
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 :
ninja install
Pour tester les résultats lancez : ninja test. Certains tests
échoueront en fonction des paquets facultatifs installés.