RSS Feed

Lisp Project of the Day

declt

You can support this project by donating at:

Donate using PatreonDonate using Liberapay

Or see the list of project sponsors.

decltdocumentation

Documentation😀
Docstrings😀
Tests 🥺
Examples🥺
RepositoryActivity😀
CI 🥺
License BSD
HomePagehttps://github.com/didierverna/declt

This is the documentation builder behind Quickref site. It is good for generating API references for third party libraries.

Most interesting features of Declt are:

  • Declt uses Texinfo file format for intermediate document store. This makes it possible to generate not only HTML but also PDF and other output formats.
  • It can automatically include license text into the documentation. But this works only for a number of popular licenses like MIT, BSD, GPL, LGPL and BOOST.

As always, I've created a template project, ready to be used:

https://github.com/cl-doc-systems/declt

Here is how it is rendered in HTML:

https://cl-doc-systems.github.io/declt/

And in PDF:

https://cl-doc-systems.github.io/declt/index.pdf

Sadly, Declt does not support markup in docstrings and cross-referencing does not work there.

Some other pros and cons are listed on example site.

Remember, all example projects from https://github.com/cl-doc-systems include a build script and GitHub Action to update documentation on every commit!


Brought to you by 40Ants under Creative Commons License