Package: liber

Function liber:generate-html-documentation

Lambda List

liber:generate-html-documentation (packages directory &key author author-url date index-title heading css  icon single-page-p paginate-section-p include-slot-definitions-p include-internal-symbols-p)

Arguments

packages -- list of package designators, documentation will be generated for these packages
directory -- a pathname specifying a directory, all output files and temporary data will be written to this directory, which must already exist
index-title -- a string for the title of the main page, index.html, other pages will be named according to the object they are documenting
heading -- a string for a visible title on top of every page
css -- a pathname or namestring pointing to a cascading stylesheet (CSS) file, this file will be copied to the target directory under the name index.css, if this argument is a string and does not start with a dot, it will be taken as namestring relative to the liber/css directory
single-page-p -- a boolean
include-slot-definitions-p -- a boolean
include-internal-symbols-p -- a boolean

Return Value

The pathname of the generated file index.xml.

Details

Generates HTML documentation for packages. With single-page-p, all documentation is assembled as a single page called index.html. Otherwise, index.html will include only a symbol index and a summary of each package, with links to other pages.

With include-slot-definitions-p, pages for symbols that are not exported will be included, so that documentation for exported symbols can safely refer to internal pages (but internal symbols will not be included in the symbol index automatically). This option has no effect if single-page-p is enabled.

With include-slot-definition, class documentation will include a list of direct slots.
 

See also

2025-09-06