erudite

API Reference

erudite

Literate Programming System for Common Lisp

ERUDITE

Erudite is a Literate Programming System for Common Lisp
  • Variable *SHORT-COMMENTS-PREFIX*
    ";;"
  • Variable *SYNTAX*
    :erudite
  • Variable *OUTPUT-TYPE*
    :latex
  • Variable *TITLE*
    nil
  • Variable *SUBTITLE*
    nil
  • Variable *CATCH-ERRORS-P*
    t
  • Variable *VERBOSE*
    nil
  • Variable *DEBUG*
    nil
  • Variable *CODE-INDEXING*
    t
  • Variable *ERUDITE-PACKAGE*
    (find-package :erudite)
  • Variable *IMPLICIT-DOC*
    t
  • Variable *IMPLICIT-CODE*
    t
  • Function ERUDITE (destination file-or-files &rest args &key (output-type *output-type*) (syntax *syntax*) (debug *debug*) (verbose *verbose*) (catch-errors-p *catch-errors-p*) (code-indexing *code-indexing*) (implicit-doc *implicit-doc*) (implicit-code *implicit-code*) (short-comments-prefix *short-comments-prefix*) &allow-other-keys)
    Processes literate lisp files and creates a document. Args: - destination: If NIL, output is written to a string. If T, output is written to *standard-output*. If a pathname, then a file is created. Otherwise, a stream is expected. - files: Literate lisp files to compile - args: All sort of options passed to the generation functions - output-type: The kind of document to generate. One of :latex, :sphinx Default: :latex - syntax: The kind of syntax used in the literate source files. One of: :erudite, :latex, :org, :sphinx. Default: :erudite