2 CLI

Guile Documentá comes with the documenta program, which recognizes the following subcommands:

Note: Guile Documentá does not currently extract CLI (Command Line Interface) documentation from the source code, but it is intended to do so in the future. The following documentation is (re)written by hand (sadly).

Command: api source [destination]

Extract the API (Application Programming Interface) documentation of the Guile Scheme modules defined in the source path.

Argument: source

A path to a Guile Scheme module file or to a directory containing Guile Scheme modules. For example: "project-x/libx.scm", "project-z/libz".

Argument: destination

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