Beyond Linux® From Scratch - Version 8.1

Chapter 11. General Utilities

GTK-Doc-1.26

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-8.1 platform.

Package Information

GTK-Doc Dependencies

Required

docbook-xml-4.5, docbook-xsl-1.79.1, itstool-2.0.2, libxslt-1.1.29, and Python-2.7.13

Recommended

Highlight-3.39

Optional

dblatex or fop-2.2 (XML PDF support), GLib-2.52.3 (for the test suite), GNOME Doc Utils and Which-2.21 (required for the test suite and gtk-doc documentation), and six (for some tests)

Required (runtime)

six-1.10.0

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

To test the results, issue: make check.

Now, as the root user: 

make install

Contents

Installed Programs: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, and gtkdoc-scangobj
Installed Libraries: None
Installed Directories: /usr/lib/cmake/GtkDoc, /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 2017-08-29 13:15:22 -0700