#### Beyond Linux® From Scratch (systemd Edition) - Version 10.1

### Chapter 11. General Utilities

- Prev

  Graphviz-2.44.1

- Next

  Hd2u-1.0.4

- Up
- Home

# GTK-Doc-1.33.2

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

### Package Information

- Download (HTTP): https://download.gnome.org/sources/gtk-doc/1.33/gtk-doc-1.33.2.tar.xz

- Download (FTP): ftp://ftp.acc.umu.se/pub/gnome/sources/gtk-doc/1.33/gtk-doc-1.33.2.tar.xz

- Download MD5 sum: ea6563421abe964d02135ca0d5b8dd8e

- Download size: 496 KB

- Estimated disk space required: 13 MB (with tests)

- Estimated build time: 0.2 SBU (with tests)

### 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.8.0 at run time

#### Optional

For tests: dblatex or fop-2.6 (XML PDF support), GLib-2.66.7, Which-2.21, and Python modules lxml-4.6.2, parameterized, and yelp-tools

### 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:

    autoreconf -fiv           &&
    ./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/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

Last updated on 2021-02-19 22:13:48 -0800

- Prev

  Graphviz-2.44.1

- Next

  Hd2u-1.0.4

- Up
- Home