BASIC USAGE

Guile Documentá can extract the Texinfo documentation of a single Guile Scheme module or all the modules in a Guile "package". For example:

# Save API documentation of "some-module" to doc/api/index.texi (default)
documenta api path/to/some-module.scm

# Save API documentation of "some-package" to doc/api/index.texi (default)
documenta api path/to/some-package

# Save API documentation of "mylib" to a specific directory
documenta api mylib /tmp/mylib-doc/api

Check out Guile Documentá API documentation for an example of the structure of the generated documentation.

INSTALLATION

Guile Documentá can be installed on any GNU/Linux device using the GNU Guix package manager and luis-felipe-x (my personal Guix channel). For example, to try out the software without affecting your personal environment:

# Clone the channel to a temporary directory
cd /tmp
git clone https://codeberg.org/luis-felipe/guix-channel-x luis-felipe-x
# Start a Guix shell providing guile-documenta
guix shell -L luis-felipe-x guile guile-documenta
# Now you can use the "documenta" program

Eventually, Guile Documentá will be available from Guix's official channel and the installation will be simply:

guix install guile guile-documenta

CONTACT

You can send any questions or feedback by email to the maintainer.