The GTK-Doc package contains a code documenter. This is useful for extracting specially formatted comments from the code to create API documentation. This package is optional; if it is not installed, packages will not build the documentation. This does not mean that you will not have any documentation. If GTK-Doc is not available, the install process will copy any pre-built documentation to your system.
This package is known to build and work properly using an LFS 11.3 platform.
Download (HTTP): https://download.gnome.org/sources/gtk-doc/1.33/gtk-doc-1.33.2.tar.xz
Download (FTP): ftp://ftp.acc.umu.se/pub/gnome/sources/gtk-doc/1.33/gtk-doc-1.33.2.tar.xz
Download MD5 sum: ea6563421abe964d02135ca0d5b8dd8e
Download size: 496 KB
Estimated disk space required: 13 MB (with tests)
Estimated build time: 0.2 SBU (with tests)
docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7, and libxslt-1.1.37
Pygments-2.14.0 at run time
For tests: dblatex or fop-2.8 (XML PDF support), GLib-2.74.5, Which-2.21, and Python modules lxml-4.9.2, parameterized, and yelp-tools
![[Note]](../images/note.png)
The optional python modules above can be easily installed with the pip3 command.
User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc
Install GTK-Doc by running the following commands:
autoreconf -fiv && ./configure --prefix=/usr && make
The test suite will hang if the package (or a previous version) is not already installed.
Now, as the root user:
make install
To test the results, issue: make check. Some tests will fail depending on optionally installed packages.