Package atdoc

Atdoc generates documentation for Common Lisp packages.

It extracts documention strings written using a custom markup language and generates HTML pages or TeX documents.



About This Package

Generating formatted documentation
Generating unformatted XML

Generating formatted documentation

Separate functions are offered for each output format: HTML pages, LaTeX/PDF output, and .info files. There is also an older function called generate-documentation, which in now an alias for generate-html-documentation.

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.

Generates TeX documentation for packages.

With run-tex-p (the default), pdflatex is run automatically to generate a PDF file.

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

Generates TeX documentation for packages.

With run-tex-p (the default), pdflatex is run automatically to generate a PDF file.

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

A deprecated alias for generate-html-documentation.

Generating unformatted XML

Power users might want to extract docstrings into XML and then send that XML through their own XSLT stylesheets. The following function can be used for that purpose.

Extracts docstrings from packages and writes them in XML syntax to .atdoc.xml in the specified directory.

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

Extra parameters will be inserted as attributes on the root element.

Exported Symbol Index

extract-documentation, function
generate-documentation, function
generate-html-documentation, function
generate-info-documentation, function
generate-latex-documentation, function