Next: Pipeline Usage, Previous: Overview, Up: The Declt User Manual [Contents][Index]
This chapter explains how to use Declt to trigger the whole pipeline (see Overview), that is, to go directly from a library to a reference manual.
Declt’s main system is called ‘net.didierverna.declt’. Depending
on your installation, you may thus either asdf:load-system, or
ql:quickload it in your Lisp image.
Declt’s main package is called net.didierverna.declt. You can automatically nickname this package with the following function.
Add NICKNAME (:declt by default) to the
:net.didierverna.declt package.
In order to trigger the whole pipeline, use the declt function,
which currently generates a Texinfo file containing the reference
manual. This file may in turn be compiled into a variety of
human-readable formats with the makeinfo program.
Generate a reference manual in Texinfo format for ASDF
SYSTEM-NAME.
SYSTEM-NAME is an ASDF system designator.
The declt function accepts a number of keyword arguments which
affect the behavior of every stage of the pipeline (they are in fact
passed along to the corresponding functions, which see). The following
sections describe these keyword arguments.