https://github.com/rudolfochrist/quicklisp-docs

Generate documentation for Quicklisp installed libraries.
https://github.com/rudolfochrist/quicklisp-docs

Last synced: 18 days ago
JSON representation

Generate documentation for Quicklisp installed libraries.

• Host: GitHub
• URL: https://github.com/rudolfochrist/quicklisp-docs
• Owner: rudolfochrist
• License: mit
• Created: 2016-02-01T18:26:44.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-10T17:35:17.000Z (over 8 years ago)
• Last Synced: 2024-12-05T17:46:37.788Z (about 2 months ago)
• Language: Common Lisp
• Size: 22.5 KB
• Stars: 5
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+title: quicklisp-docs

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

* Installation

** Lisp Side

Please ensure [[https://www.quicklisp.org/beta/][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:

#+BEGIN_SRC emacs-lisp

(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)

#+END_SRC

If you install a new library during a REPL session, call =ql-docs-reload-docs= again to fetch the new

documentation.

* License

MIT

See [[file:LICENSE][LICENSE]].