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.
![[Note]](../images/note.png)
This package is known to build and work properly using an LFS 13.0 platform.
Download (HTTP): https://download.gnome.org/sources/gtk-doc/1.35/gtk-doc-1.35.1.tar.xz
Download MD5 sum: 16817ad9e0bef63358b29b63f7738bbd
Download size: 528 KB
Estimated disk space required: 12 MB (with tests)
Estimated build time: less than 0.1 SBU (with tests)
docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.86.4, itstool-2.0.7, libxslt-1.1.45, and Pygments-2.19.2
For tests: dblatex or fop-2.11 (XML PDF support), Which-2.23, and Python modules lxml-6.0.2, parameterized, and yelp-tools
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. One test, test-gobject-mkhtml, is known to fail due to
issues with newer versions of libxml2.