About 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.



Contents

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.

Function generate-html-documentation (packages directory &key (index-title No Title) (heading No Heading) (css default.css) (logo nil) (single-page-p nil) (include-slot-definitions-p nil) (include-internal-symbols-p t))
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 -- This string will be used as the title of the main page, index.html. (Other pages will be named according to the object they are documenting.)
  • heading -- This string will be used as a visible title on top of every page.
  • logo -- Deprecated.
  • css -- A pathname or string 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 atdoc/css directory.
  • single-page-p -- A boolean.
  • include-slot-definitions-p -- A boolean.
  • include-internal-symbols-p -- A boolean.
Returns:
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.

Function generate-latex-documentation (packages directory &key (title No Title) (run-tex-p pdflatex) (include-slot-definitions-p nil))
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.
  • title -- This string will be used as the document's title.
  • include-slot-definitions-p -- A boolean.
  • run-tex-p -- A boolean.
Returns:
The pathname of the generated file documentation.pdf, or nil.
Details:
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.

Function generate-info-documentation (packages directory &key name (title No Title) (include-slot-definitions-p nil))
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.
  • title -- This string will be used as the document's title.
  • include-slot-definitions-p -- A boolean.
Returns:
The pathname of the generated file documentation.pdf, or nil.
Details:
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.

Function generate-documentation (&rest args)
Details:
A deprecated alias for generate-html-documentation.
See also:

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.

Function extract-documentation (packages directory &rest keys &key include-slot-definitions-p &allow-other-keys)
Arguments:
  • packages -- List of package designators. Documentation will be generated for these packages.
  • directory -- A pathname specifying a directory. The output file will be written to this directory, which must already exist.
  • include-slot-definitions-p -- A boolean.
  • keys -- Extra parameters for stylesheets.
Details:
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.

Index of exported symbols

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