Guile Documentá version 0.2.1

Generate API documentation for GNU Guile Scheme projects.

BASIC USAGE

❶ Document your source code in Texinfo format (see an example).

❷ Extract the documentation with Guile Documentá.

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

❸ Include the generated API docs in the main Texinfo file of your project documentation. For example:

@include api/index.texi
❹ Build your project documentation (using texi2any, for example).

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. If the package is unknown, you may need to guix pull then try again.

guix install guile-documenta
# Now you can use the "documenta" program

CONTACT

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