Codex

Internals

Manifest

The manifest and its components are represented by the following classes:

manifest
Manifest options.
  • markup-format
    The markup format used in docstrings.
  • systems
    A list of systems to document.
  • documents
    A list of documents.
document
A Codex document. Project manifests can define multiple documents, e.g. a manual, a tutorial, an advanced manual.
  • document-title
    The document's title.
  • document-authors
    A list of the document's authors.
  • output-format
    The document's output format.
  • document-sources
    A list of pathnames to source files to build the document from.
output-format
The base class of all output formats.
    html
    The base class of HTML formats.
    • html-template
      The name of the HTML template.
    • template-options
      A property list of template initargs.
    single-html
    Single-file HTML output.
      multi-html
      Multi-file HTML output.

        Errors

        The following is a list of the error conditions Codex can signal:

        codex-error
        The base class of all Codex errors.
          manifest-error
          Signalled when there is an error parsing a manifest file.
          • system-name
            The name of the system.
          • message
            The error message.
          unsupported-output-format
          Signalled when Codex doesn't know the output format a document specifies.
          • format-name
            The name of the output format.
          template-error
          Signalled by errors related to templates.
          • template-name
            The template name.
          • message
            The error message.