This utility generates documentation for a library after it has been installed with quicklisp.
Please ensure Quicklisp is installed. Then clone this repository into the local-projects
directory
git clone https://github.com/rudolfochrist/quicklisp-docs.git ~/quicklisp/local-projects/
Run
(ql:quickload :quicklisp-docs)
to install quicklisp-docs
. Also, add the above line to the init file of your CL implementation.
Put
(load (expand-file-name "~/quicklisp/local-projects/quicklisp-docs/quicklisp-docs.el") t)
in your Emacs init file. Adjust the path to quicklisp accordingly.
Install libraries with quicklisp as usual
(ql:quickload :alexandria)
Per default, this installs the documentation under ~/quicklisp/docs/
. This can be customized by setting
*ql-docs-home*
.
If you don’t want to generate documentation for a specific system, then you can add it to the list of excluded systems like so:
(ql-docs:exclude-system :cl-ppcre)
To use the documentation for Alexandria (see above) from within slime-documentation-lookup
, call
(ql-docs-reload-docs) ;; <-- this is Emacs Lisp. This will certainly fail in the SLIME REPL.
Example configuration:
(load (expand-file-name "~/quicklisp/local-projects/quicklisp-docs/quicklisp-docs.el") t)
(setq ql-docs-browser-function #'eww-browse-url)
(ql-docs-reload-docs)
If you install a new library during a REPL session, call ql-docs-reload-docs
again to fetch the new
documentation.
MIT
See LICENSE.