The litterae Reference Manual

Table of Contents

The litterae Reference Manual

This is the litterae Reference Manual, version 0.3.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:55:53 2021 GMT+0.

1 Introduction

Litterae

Documentation generator

Work in progress

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 litterae

Author

Stefan Devai <stedevai@gmail.com>

License

MIT

Description

Beautiful documentation generation.

Version

0.3.0

Dependencies

• docparser
• lsx
• 3bmd
• 3bmd-ext-code-blocks
• str
• cl-yaml

Source

litterae.asd (file)

Component

source (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 litterae/source

Parent

litterae (system)

Location

source/

Components

• package.lisp (file)
• config.lisp (file)
• templates/index.lisp (file)
• litterae.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 litterae.asd

Location

litterae.asd

Systems

litterae (system)

4.1.2 litterae/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

litterae

4.1.3 litterae/source/config.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/config.lisp

Internal Definitions

• *asdf-system* (special variable)
• *config-filename* (special variable)
• *docstrings-as-markdown?* (special variable)
• *index* (special variable)
• *symbols* (special variable)
• *system-name* (special variable)
• load-config (function)
• search-and-load-config-file (function)
• set-config (function)
• set-single-config (macro)

4.1.4 litterae/source/templates/index.lisp

Dependency

config.lisp (file)

Parent

source (module)

Location

source/templates/index.lisp

Internal Definitions

• has-attr? (function)
• index-template (class)

4.1.5 litterae/source/litterae.lisp

Dependency

templates/index.lisp (file)

Parent

source (module)

Location

source/litterae.lisp

Exported Definitions

• g (function)
• generate (function)

Internal Definitions

• build-symbols-hash (function)
• do-node-lists (macro)
• do-package-hashes (macro)
• format-lambda-list (function)
• format-lambda-list-html (function)
• gen-html-node-item (function)
• generate-html (function)
• generate-html-index (function)
• generate-html-index-body (function)
• generate-id (function)
• generate-list (function)
• get-lambda-list (function)
• get-node-type-string (function)
• html-api-docs (function)
• html-hero (function)
• html-readme (function)
• html-sidebar (function)
• initialize-system-information (function)
• make-index-template (function)
• parse-markdown-docstring (function)
• read-markdown (function)

5 Packages

Packages are listed by definition order.

5.1 litterae

Source

package.lisp (file)

Use List

• lsx
• common-lisp

Exported Definitions

• g (function)
• generate (function)

Internal Definitions

• *asdf-system* (special variable)
• *config-filename* (special variable)
• *docstrings-as-markdown?* (special variable)
• *index* (special variable)
• *symbols* (special variable)
• *system-name* (special variable)
• build-symbols-hash (function)
• do-node-lists (macro)
• do-package-hashes (macro)
• format-lambda-list (function)
• format-lambda-list-html (function)
• gen-html-node-item (function)
• generate-html (function)
• generate-html-index (function)
• generate-html-index-body (function)
• generate-id (function)
• generate-list (function)
• get-lambda-list (function)
• get-node-type-string (function)
• has-attr? (function)
• html-api-docs (function)
• html-hero (function)
• html-readme (function)
• html-sidebar (function)
• index-template (class)
• initialize-system-information (function)
• load-config (function)
• make-index-template (function)
• parse-markdown-docstring (function)
• read-markdown (function)
• search-and-load-config-file (function)
• set-config (function)
• set-single-config (macro)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Functions

Function: g SYSTEM-NAME &key PATH CONFIG

Generates static HTML documentation for a ‘system-name’.

Package

litterae

Source

litterae.lisp (file)

Function: generate SYSTEM-NAME &key PATH CONFIG

Generates static HTML documentation for a **system-name**.

Package

litterae

Source

litterae.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *asdf-system*

Hold’s the system’s asdf information.

Package

litterae

Source

config.lisp (file)

Special Variable: *config-filename*

Holds the default config filename.

Package

litterae

Source

config.lisp (file)

Special Variable: *docstrings-as-markdown?*

If true, docstrings will be parsed as markdown, otherwise it uses the string as it is.

Package

litterae

Source

config.lisp (file)

Special Variable: *index*

Holds raw information about a system provided by docparser library.

Package

litterae

Source

config.lisp (file)

Special Variable: *symbols*

Structured information about the system’s symbols.

Package

litterae

Source

config.lisp (file)

Special Variable: *system-name*

Holds system’s name as symbol.

Package

litterae

Source

config.lisp (file)

6.2.2 Macros

Macro: do-node-lists (PKG-HASH) &body BODY

Iterates through lists of nodes in a ‘package-hash’ contained in ‘*index’.

Package

litterae

Source

litterae.lisp (file)

Macro: do-package-hashes (PKG PKG-HASH) &body BODY

Iterates through the package hashes in ‘*index*’

Package

litterae

Source

litterae.lisp (file)

Macro: set-single-config PARAMETER KEYWORD HASH-TABLE

Sets the value of **parameter** to the value of **keyword** in **hash-table** only if the keyword exists.

Package

litterae

Source

config.lisp (file)

6.2.3 Functions

Function: build-symbols-hash ()

Stores in ‘*symbols*’ a hash of hashes of lists: a hash of package names, which each value contains a hash of class names which, each value contains a list of node names.

Package

litterae

Source

litterae.lisp (file)

Function: format-lambda-list LST

Formats a lambda list ‘lst‘ and returns it as a string.

Package

litterae

Source

litterae.lisp (file)

Function: format-lambda-list-html LAMBDA-STRING

Returns a lambda list string with proper formated HTML.

Package

litterae

Source

litterae.lisp (file)

Function: gen-html-node-item NODE ID PKG

Returns each docparser node formated as HTML.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html PATH

Generates HTML for the contents of a parsed system in ‘*symbols*’.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html-index PATH

Generates index.html in ‘path’.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html-index-body ()

Generates the body content for the index page.

Package

litterae

Source

litterae.lisp (file)

Function: generate-id ELEMENT

Generates an id string for html given an element in the format ‘(list :id 0 :name some-name)‘.

Package

litterae

Source

litterae.lisp (file)

Function: generate-list &key ELEMENTS CHILD-LIST? ELEMENT-FORMAT

Generates a list with ‘elements’. If ‘child-list?’ is true, it uses the first element
of ‘elements’ (car) as the title and the other elements as lines of a new list. If child-list? is false, then each element in ‘elements’ will be a list.
element-format allows to customize how the element will be printed.

Package

litterae

Source

litterae.lisp (file)

Function: get-lambda-list NODE PKG

If the node is of type operator-node, the function returns its lambda list. Otherwise it returns the node-name as a string.

Package

litterae

Source

litterae.lisp (file)

Function: get-node-type-string NODE-TYPE &key PLURAL?

Return a string of ‘node-type’ for headers. If ‘plural’ is non nil, it returns its plural version.

Package

litterae

Source

litterae.lisp (file)

Function: has-attr? ATTR

Return true if the attribute ‘attr’ holds a value, false otherwise.

Package

litterae

Source

templates/index.lisp (file)

Function: html-api-docs ()

Returns the main API documentation content as a lsx object.

Package

litterae

Source

litterae.lisp (file)

Function: html-hero ()

Generates the Hero HTML.

Package

litterae

Source

litterae.lisp (file)

Function: html-readme ()

Searches for a README file in the system’s directory and returns it as a HTML string.

Package

litterae

Source

litterae.lisp (file)

Function: html-sidebar ()

Returns the sidebar used to navigate through the API.

Package

litterae

Source

litterae.lisp (file)

Function: initialize-system-information SYSTEM-NAME

Package

litterae

Source

litterae.lisp (file)

Function: load-config &optional FILEPATH

Loads config contained in **filepath**. If it’s nil, searches for a default config file to load.

Package

litterae

Source

config.lisp (file)

Function: make-index-template ()

Creates a object instance for ‘index-template’.

Package

litterae

Source

litterae.lisp (file)

Function: parse-markdown-docstring DOCSTRING

Returns a **docstring** in markdown format as a HTML string.

Package

litterae

Source

litterae.lisp (file)

Function: read-markdown FILEPATH

Reads and parses a markdown file located in ‘filepath’.

Package

litterae

Source

litterae.lisp (file)

Function: search-and-load-config-file ()

If a default config file exists, return its contents. Otherwise returns nil.

Package

litterae

Source

config.lisp (file)

Function: set-config CONFIG

Sets configs parameters from **config**, a parsed yaml file. Always returns t to indicate that a new config was set.

Package

litterae

Source

config.lisp (file)

6.2.4 Classes

Class: index-template ()

Package

litterae

Source

templates/index.lisp (file)

Direct superclasses

template (class)

Direct methods

render-object (method)

Direct slots

Slot: title

Initargs

:title

Slot: description

Initargs

:description

Slot: url

Initargs

:url

Slot: body

Initargs

:body

Slot: lang

Initargs

:lang

Initform

"en"

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types