Skip to content
Generate documentation for Quicklisp installed libraries.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.org
generator.lisp
package.lisp
quicklisp-docs-autoloads.el
quicklisp-docs.asd
quicklisp-docs.el
quicklisp-docs.lisp
tests.lisp

README.org

quicklisp-docs

This utility generates documentation for a library after it has been installed with quicklisp.

Installation

Lisp Side

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.

Emacs Side (optional)

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.

Usage

Lisp Side

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)

Emacs Side (optional)

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.

License

MIT

See LICENSE.

You can’t perform that action at this time.