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).
api
command ¶The api
command extracts API (Application Programming
Interface) documentation from one or more Guile Scheme modules.
# Extract API documentation from one Scheme file: documenta api mylib.scm # Extract API documentation from one Scheme directory (recursively): documenta api mylib # Extract API documentation from both a Scheme file and directory: documenta api "mylib.scm mylib"
Note: Having to quote the list of sources in the last example is a limitation that is expected to be removed in the future. So it could simply become:
documenta api mylib.scm mylib etc
# Save API documentation to a specific directory: documenta api mylib --destination mydoc/api
documenta api sources [--destination]
Absolute or relative paths to Guile Scheme modules that compose the code whose API documentation will be extracted. These paths can lead to both Scheme files or Scheme directories.
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)).