Beyond Linux® From Scratch (System V Edition) - Version 10.0

Chapter 11. General Utilities

GTK-Doc-1.32

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.

This package is known to build and work properly using an LFS-10.0 platform.

Package Information

GTK-Doc Dependencies

Required

docbook-xml-4.5, docbook-xsl-1.79.2, itstool-2.0.6, and libxslt-1.1.34

Recommended

Pygments-2.6.1 at run time

Optional

For tests: dblatex or fop-2.5 (XML PDF support), GLib-2.64.4, Which-2.21, and Python modules lxml-4.5.2, anytree, and parameterized

[Note]

Note

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

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc

Installation of GTK-Doc

Install GTK-Doc by running the following commands: 

./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.

Contents

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/help/*/gtk-doc-manual

Short Descriptions

gtkdoc*

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

Last updated on 2020-08-16 21:26:53 -0700