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 12.4 platform.
Download (HTTP): https://download.gnome.org/sources/gtk-doc/1.35/gtk-doc-1.35.1.tar.xz
Download SHA256 Sum: 611c9f24edd6d88a8ae9a79d73ab0dc63c89b81e90ecc31d6b9005c5f05b25e2
Download MD5 sum: 16817ad9e0bef63358b29b63f7738bbd
Download size: 4,437.5 KB
Estimated disk space required: 9,335.3 KB
Estimated build time: less than 0.1 SBU
docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.86.2, itstool-2.0.7, libxslt-1.1.43, and Pygments-2.19.2
For tests: dblatex or "fop" (XML PDF support), Which-2.23, and Python modules lxml-6.0.2, parameterized, and yelp-tools
![[Note]](../images/note.png)
The optional python modules above can be easily installed with the pip3 command.
Prepare GTK-Doc by running the following commands:
meson setup build --prefix=/usr --buildtype=release
ninja -C build
The test suite will hang if the package (or a previous version) is not already installed.
Now Install the package, as the root user:
ninja -C build install
To test the results, issue: ninja test.
Some tests will fail depending on optionally installed packages. One test,
test-gobject-mkhtml, is known to fail due to issues
with newer versions of libxml2.