3.2 (documenta commands)

This module defines procedures that are associated to every command provided by the command-line interface of the documenta program. See the CLI and See (documenta cli) sections for additional information.

This module provides the following interface.

3.2.1 Procedures

Procedure: api source OPT: destination

Extract the API documentation of the Guile Scheme source package or module.

source (string): An absolute or relative path to a single Guile Scheme module file or to a directory containing a collection of modules. For example: «projects/project-x/libx.scm», «projects/project-z/libz».

destination (string): Optional path to a directory where the final Texinfo files will be saved. If not provided, DEFAULT_DOC_PATH is used (see the module (documenta commands)).

Result: The API documentation is saved to the destination directory.

3.2.2 Variables

Variable: DEFAULT_DOC_PATH
"doc/api"