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.2 platform.
Download (HTTP): https://download.gnome.org/sources/gtk-doc/1.34/gtk-doc-1.34.0.tar.xz
Download MD5 sum: f0e7385ba25eddb6ce0953e8cf63d1bf
Download size: 484 KB
Estimated disk space required: 14 MB (with tests)
Estimated build time: 0.2 SBU (with tests)
docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.80.4, itstool-2.0.7, libxslt-1.1.42, and Pygments-2.18.0
For tests: dblatex or fop-2.9 (XML PDF support), GLib-2.80.4, Which-2.21, and Python modules lxml-5.3.0, parameterized, and yelp-tools
![[Note]](../images/note.png)
The optional python modules above can be easily installed with the pip3 command.
Install GTK-Doc by running the following commands:
mkdir -p build && cd build && meson setup --prefix=/usr --buildtype=release .. && ninja
The test suite will hang if the package (or a previous version) is not already installed.
Now, as the root user:
ninja install
To test the results, issue: ninja test. Some tests will fail depending on optionally installed packages.