Dear all,
I'm happy to announce the first public release of Quickref, a global
documentation project for Common Lisp.
Quickref automatically builds a website[1] containing reference manuals
for Quicklisp libraries (either those already installed or all of
them). The reference manuals are generated by Declt[2] (probably the
most complete documentation system for Lisp today) in Texinfo format,
and then processed by makeinfo. Because Declt works by introspection,
this whole process is non-intrusive: library authors do not need to do
anything to support them being documented.
The official Quickref website is kept up-to-date with Quicklisp, and
currently documents 1588 libraries successfully. This work is the result
of a collaboration with Antoine Martin, as part of an internship at
LRDE. The project is still evolving: a new student will arrive in
September to work on parallelization.
The source code is available here:
https://gitlab.common-lisp.net/quickref/quickref
The resulting website may also be regenerated locally with this Docker
2-liner:
docker run --name quickref quickref/quickref
docker cp quickref:/home/quickref/quickref .
Footnotes:
[1]
http://quickref.common-lisp.net
[2]
https://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
--
Resistance is futile. You will be jazzimilated.
Lisp, Jazz, Aïkido:
http://www.didierverna.info