Introduction to GTK-Doc

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.



Development versions of BLFS may not build or run some packages properly if LFS or dependencies have been updated since the most recent stable versions of the books.

Package Information

GTK-Doc Dependencies


docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7, and libxslt-1.1.38



For tests: dblatex or fop-2.9 (XML PDF support), GLib-2.78.1, Which-2.21, and Python modules lxml-4.9.3, parameterized, and yelp-tools



The optional python modules above can be easily installed with the pip3 command.

Installation of GTK-Doc

Install GTK-Doc by running the following commands:

autoreconf -fiv           &&
./configure --prefix=/usr &&

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.


Installed Programs: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, and gtkdoc-scangobj
Installed Libraries: None
Installed Directories: /usr/share/gtk-doc and /usr/share/cmake/GtkDoc

Short Descriptions


these are all shell, or Python scripts used by package Makefile scripts to generate documentation for the package being built