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

### Chapter 11. General Utilities

- Prev

  Graphviz-12.2.1

- Next

  Highlight-4.15

- Up
- Home

# GTK-Doc-1.34.0

## 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 12.3 platform.

### Package Information

- 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)

### GTK-Doc Dependencies

#### Required

docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.82.5, itstool-2.0.7, libxslt-1.1.42, and Pygments-2.19.1

#### Optional

For tests: dblatex or fop-2.10 (XML PDF support), Which-2.23, and Python modules lxml-5.3.1, parameterized, and yelp-tools

### Note

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:

    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.

## 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/cmake/GtkDoc

### Short Descriptions

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

- Prev

  Graphviz-12.2.1

- Next

  Highlight-4.15

- Up
- Home