RSS Feed

Lisp Project of the Day


You can support this project by donating at:

Donate using PatreonDonate using Liberapay

Or see the list of project sponsors.


Tests 😀
CI 🥺

This is a very cool documentation generator for Common Lisp projects.

The most interesting features are:

  • Emacs/SLIME integration.
  • Ability to generate Markdown.
  • API to add new entity types.
  • Linking to the sources on the GitHub.
  • Docstrings deindentation.
  • Generation docs for multiple ASDF systems with cross-referencing.
  • Auto-export of documented symbols.

Some cons:

  • The recommended way to mix documentation section with code leads to the runtime dependency from PAX and all it's dependencies. But you might define documentation as a separate ASDF system.
  • It is inconvenient to write Markdown in docstrings. Is there any way to teach Emacs to use markdown minor mode for documentation strings?

There are more pros and cons. All of them are listed in the example project. It is up and ready to be cloned. Use it as a template for your own Common Lisp library with great documentation!

You'll find all such templates in this GitHub organization:

I have plans to review a few other documentation builders, but MGL-PAX is my favourite so far.

Brought to you by 40Ants under Creative Commons License