Beyond Linux® From Scratch (systemd edition) - Version 7.6-systemd

Chapter 11. General Utilities

GTK-Doc-1.20

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-7.6 systemd platform.

Package Information

GTK-Doc Dependencies

Required

docbook-xml-4.5, docbook-xsl-1.78.1, Itstool-2.0.2 and libxslt-1.1.28

Optional

dblatex or fop-1.1 (XML PDF support), GLib-2.40.0 (for the test suite), GNOME Doc Utils and Which-2.20 (required for the test suite and gtk-doc documentation), Highlight-3.18, OpenJade-1.3.2 with docbook-4.5 and docbook-dsssl-1.79 (SGML support, not actively maintained any more), Python-2.7.8 (builds gtkdoc-depscan), and Rarian-0.8.1

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: gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdocize, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj
Installed Libraries: None
Installed Directories: /usr/share/{gtk-doc,help/*/gtk-doc-manual,sgml/gtk-doc}

Short Descriptions

gtkdoc*

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

Last updated on 2014-08-23 12:03:12 -0700