Generate API documentation for GNU Guile Scheme projects.
Generate API documentation for GNU Guile Scheme projects.
an example).
❷ Extract the documentation with Guile Documentá.
# Save API documentation of a Scheme module to doc/api/index.texi (default) documenta api somelibx.scm # Or the API documentation of a Scheme directory documenta api someliby # Or the API documentation of one or more related sources documenta api "somelibz.scm somelibz" # You can also save the API documentation to any directory documenta api mylib --destination mydocs/api
❸ Include the generated API docs in the main Texinfo file of your project documentation. For example:
@include api/index.texi
texi2any, for example).Check out Guile Documentá Manual for more information. Its API section is itself an example of the API structure generated by Documentá.
Guile Documentá can be installed on any GNU/Linux device using the GNU Guix package manager.
guix install guile-documenta
Once installed, you can start using
the documenta program.
You can send any questions or feedback by email to the maintainer or use the public issue tracker.
This software is in the public domain. Get the source files.