The sphinx Reference Manual

This is the sphinx Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:30:30 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 sphinx

Dependencies
  • docutils (system).
  • closure-template (system).
  • cl-fad (system).
  • colorize (system).
Source

sphinx.asd.

Child Component

src (module).


2 Modules

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


2.1 sphinx/src

Source

sphinx.asd.

Parent Component

sphinx (system).

Child Components

3 Files

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


3.1 Lisp


3.1.1 sphinx/sphinx.asd

Source

sphinx.asd.

Parent Component

sphinx (system).

ASDF Systems

sphinx.


3.1.2 sphinx/src/packages.lisp

Source

sphinx.asd.

Parent Component

src (module).

Packages

sphinx.


3.1.3 sphinx/src/document.lisp

Dependency

packages.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Internals

3.1.4 sphinx/src/toctree.lisp

Dependency

document.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Public Interface

visit-node (method).

Internals

3.1.5 sphinx/src/ref.lisp

Dependency

document.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.6 sphinx/src/resolve.lisp

Dependency

document.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Public Interface

transform (method).

Internals

3.1.7 sphinx/src/cl.lisp

Dependency

document.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.8 sphinx/src/reader.lisp

Dependency

toctree.lisp (file).

Source

sphinx.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.9 sphinx/src/writer.lisp

Dependencies
Source

sphinx.asd.

Parent Component

src (module).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 sphinx

Source

packages.lisp.

Use List
  • common-lisp.
  • iterate.
Public Interface

make-documentation (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-documentation (contents target-dir &key verbose)
Package

sphinx.

Source

writer.lisp.


5.1.2 Standalone methods

Method: allowed-child-p ((parent description) node &optional index)
Package

docutils.

Source

cl.lisp.

Method: read-document :around (source (reader reader))
Package

docutils.

Source

reader.lisp.

Method: read-document (source (reader reader))
Package

docutils.

Source

reader.lisp.

Method: transform ((transform resolve-static-files))
Package

docutils.

Source

resolve.lisp.

Method: transform ((transform inner-reference-map))
Package

docutils.

Source

ref.lisp.

Method: transform ((transform api-reference-map-transform))
Package

docutils.

Source

cl.lisp.

Method: transforms ((reader reader))
Package

docutils.

Source

reader.lisp.

Method: visit-node ((writer html-writer) (node inner-reference))
Package

docutils.

Source

ref.lisp.

Method: visit-node ((write html-writer) (node hyperspec-ref))
Package

docutils.

Source

cl.lisp.

Method: visit-node ((writer html-writer) (node code-block))
Package

docutils.

Source

cl.lisp.

Method: visit-node ((writer html-writer) (node toctree))
Package

docutils.

Source

toctree.lisp.

Method: visit-node ((writer sphinx-html-writer) (node subtitle))
Package

docutils.

Source

writer.lisp.

Method: visit-node ((writer sphinx-html-writer) (node title))
Package

docutils.

Source

writer.lisp.

Method: visit-node ((write html-writer) (node description))
Package

docutils.

Source

cl.lisp.

Method: visit-node ((write html-writer) (node common-lisp-entity))
Package

docutils.

Source

cl.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *api-reference-map*
Package

sphinx.

Source

cl.lisp.

Special Variable: *current-document*
Package

sphinx.

Source

document.lisp.

Special Variable: *directives*
Package

sphinx.

Source

document.lisp.

Special Variable: *inner-reference-map*
Package

sphinx.

Source

ref.lisp.

Special Variable: *interpreted-roles*
Package

sphinx.

Source

document.lisp.

Special Variable: *root*
Package

sphinx.

Source

document.lisp.

Special Variable: *root-path*
Package

sphinx.

Source

document.lisp.

Special Variable: *verbose*
Package

sphinx.

Source

reader.lisp.


5.2.2 Macros

Macro: def-common-lisp-entity-role (name &optional description-class)
Package

sphinx.

Source

cl.lisp.

Macro: def-entity-description-directive (directive class)
Package

sphinx.

Source

cl.lisp.

Macro: with-sphinx-markup (&body body)
Package

sphinx.

Source

document.lisp.

Macro: with-tag ((tag &optional class) &body body)
Package

sphinx.

Source

cl.lisp.


5.2.3 Ordinary functions

Function: api-reference-href (node)
Package

sphinx.

Source

cl.lisp.

Function: compile-template (path)
Package

sphinx.

Source

writer.lisp.

Function: document-childs-recursively (doc)
Package

sphinx.

Source

document.lisp.

Function: document-name (doc)
Package

sphinx.

Source

document.lisp.

Function: document-path (doc)
Package

sphinx.

Source

document.lisp.

Function: entity-full-name (entity)
Package

sphinx.

Source

cl.lisp.

Function: entity-id (entity)
Package

sphinx.

Source

cl.lisp.

Function: headline (node h)
Package

sphinx.

Source

writer.lisp.

Function: inner-reference-href (node)
Package

sphinx.

Source

ref.lisp.

Function: make-contents-plist (doc)
Package

sphinx.

Source

writer.lisp.

Function: make-relavive-href (href base)
Package

sphinx.

Source

resolve.lisp.

Function: parse-common-lisp-entity (str)
Package

sphinx.

Source

cl.lisp.

Package

sphinx.

Source

cl.lisp.

Function: resolve-doc (doc base)
Package

sphinx.

Source

resolve.lisp.

Function: static-href (name)
Package

sphinx.

Source

resolve.lisp.

Function: write-html (doc path template)
Package

sphinx.

Source

writer.lisp.


5.2.4 Generic functions

Generic Reader: code-block-code (object)
Package

sphinx.

Methods
Reader Method: code-block-code ((code-block code-block))

automatically generated reader method

Source

cl.lisp.

Target Slot

code.

Generic Reader: code-block-lang (object)
Package

sphinx.

Methods
Reader Method: code-block-lang ((code-block code-block))

automatically generated reader method

Source

cl.lisp.

Target Slot

lang.

Generic Reader: document-childs (object)
Package

sphinx.

Methods
Reader Method: document-childs ((document document))

automatically generated reader method

Source

document.lisp.

Target Slot

childs.

Generic Writer: (setf document-childs) (object)
Package

sphinx.

Methods
Writer Method: (setf document-childs) ((document document))

automatically generated writer method

Source

document.lisp.

Target Slot

childs.

Generic Reader: entity-arglist (object)
Package

sphinx.

Methods
Reader Method: entity-arglist ((description description))

automatically generated reader method

Source

cl.lisp.

Target Slot

arglist.

Generic Reader: entity-description-class (object)
Package

sphinx.

Methods
Reader Method: entity-description-class ((common-lisp-entity common-lisp-entity))

automatically generated reader method

Source

cl.lisp.

Target Slot

description-class.

Generic Reader: entity-name (object)
Package

sphinx.

Methods
Reader Method: entity-name ((common-lisp-entity common-lisp-entity))

automatically generated reader method

Source

cl.lisp.

Target Slot

name.

Reader Method: entity-name ((description description))

automatically generated reader method

Source

cl.lisp.

Target Slot

name.

Generic Reader: entity-package (object)
Package

sphinx.

Methods
Reader Method: entity-package ((common-lisp-entity common-lisp-entity))

automatically generated reader method

Source

cl.lisp.

Target Slot

package.

Reader Method: entity-package ((description description))

automatically generated reader method

Source

cl.lisp.

Target Slot

package.

Generic Reader: hyperspec-ref-spec (object)
Package

sphinx.

Methods
Reader Method: hyperspec-ref-spec ((hyperspec-ref hyperspec-ref))

automatically generated reader method

Source

cl.lisp.

Target Slot

spec.

Generic Reader: inner-reference-id (object)
Package

sphinx.

Methods
Reader Method: inner-reference-id ((inner-reference inner-reference))

automatically generated reader method

Source

ref.lisp.

Target Slot

id.

Generic Reader: inner-reference-title (object)
Package

sphinx.

Methods
Reader Method: inner-reference-title ((inner-reference inner-reference))

automatically generated reader method

Source

ref.lisp.

Target Slot

title.

Generic Function: show-description-title (entity)
Package

sphinx.

Source

cl.lisp.

Methods
Method: show-description-title ((entity variable-description))
Method: show-description-title :around (entity)
Method: show-description-title (entity)
Generic Reader: toctree-maxdepth (object)
Package

sphinx.

Methods
Reader Method: toctree-maxdepth ((toctree toctree))

automatically generated reader method

Source

toctree.lisp.

Target Slot

maxdepth.


5.2.5 Standalone methods

Method: do-transforms ((transforms list) (document document))
Package

docutils.

Source

document.lisp.


5.2.6 Classes

Class: api-reference-map-transform
Package

sphinx.

Source

cl.lisp.

Direct superclasses

transform.

Direct methods

transform.

Class: code-block
Package

sphinx.

Source

cl.lisp.

Direct superclasses

raw.

Direct methods
Direct slots
Slot: lang
Initargs

:lang

Readers

code-block-lang.

Writers

This slot is read-only.

Slot: code
Initargs

:code

Readers

code-block-code.

Writers

This slot is read-only.

Class: common-lisp-entity
Package

sphinx.

Source

cl.lisp.

Direct superclasses

raw.

Direct methods
Direct slots
Slot: package
Package

common-lisp.

Initargs

:package

Readers

entity-package.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

entity-name.

Writers

This slot is read-only.

Slot: description-class
Initargs

:description-class

Readers

entity-description-class.

Writers

This slot is read-only.

Class: description
Package

sphinx.

Source

cl.lisp.

Direct superclasses

raw.

Direct subclasses
Direct methods
Direct slots
Slot: package
Package

common-lisp.

Initargs

:package

Readers

entity-package.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

entity-name.

Writers

This slot is read-only.

Slot: arglist
Initargs

:arglist

Readers

entity-arglist.

Writers

This slot is read-only.

Class: document
Package

sphinx.

Source

document.lisp.

Direct superclasses

document.

Direct methods
Direct slots
Slot: prev
Slot: next
Package

iterate.

Slot: childs
Readers

document-childs.

Writers

(setf document-childs).

Class: function-description
Package

sphinx.

Source

cl.lisp.

Direct superclasses

description.

Class: hyperspec-ref
Package

sphinx.

Source

cl.lisp.

Direct superclasses

raw.

Direct methods
Direct slots
Slot: spec
Initargs

:spec

Readers

hyperspec-ref-spec.

Writers

This slot is read-only.

Class: inner-reference
Package

sphinx.

Source

ref.lisp.

Direct superclasses

raw.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

inner-reference-id.

Writers

This slot is read-only.

Slot: title
Initargs

:title

Readers

inner-reference-title.

Writers

This slot is read-only.

Class: inner-reference-map

Fill *inner-reference-map*

Package

sphinx.

Source

ref.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority300
Class: macro-description
Package

sphinx.

Source

cl.lisp.

Direct superclasses

description.

Class: reader
Package

sphinx.

Source

reader.lisp.

Direct superclasses

rst-reader.

Direct methods
Class: resolve-static-files

Resolve static dependancies

Package

sphinx.

Source

resolve.lisp.

Direct superclasses

transform.

Direct methods

transform.

Direct Default Initargs
InitargValue
:priority850
Class: sphinx-html-writer
Package

sphinx.

Source

writer.lisp.

Direct superclasses

html-writer.

Direct methods
Class: toctree
Package

sphinx.

Source

toctree.lisp.

Direct superclasses

paragraph.

Direct methods
Direct slots
Slot: maxdepth
Initform

1

Initargs

:maxdepth

Readers

toctree-maxdepth.

Writers

This slot is read-only.

Class: variable-description
Package

sphinx.

Source

cl.lisp.

Direct superclasses

description.

Direct methods

show-description-title.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   M   P   R   S   T   V   W  
Index Entry  Section

(
(setf document-childs): Private generic functions
(setf document-childs): Private generic functions

A
allowed-child-p: Public standalone methods
api-reference-href: Private ordinary functions

C
code-block-code: Private generic functions
code-block-code: Private generic functions
code-block-lang: Private generic functions
code-block-lang: Private generic functions
compile-template: Private ordinary functions

D
def-common-lisp-entity-role: Private macros
def-entity-description-directive: Private macros
do-transforms: Private standalone methods
document-childs: Private generic functions
document-childs: Private generic functions
document-childs-recursively: Private ordinary functions
document-name: Private ordinary functions
document-path: Private ordinary functions

E
entity-arglist: Private generic functions
entity-arglist: Private generic functions
entity-description-class: Private generic functions
entity-description-class: Private generic functions
entity-full-name: Private ordinary functions
entity-id: Private ordinary functions
entity-name: Private generic functions
entity-name: Private generic functions
entity-name: Private generic functions
entity-package: Private generic functions
entity-package: Private generic functions
entity-package: Private generic functions

F
Function, api-reference-href: Private ordinary functions
Function, compile-template: Private ordinary functions
Function, document-childs-recursively: Private ordinary functions
Function, document-name: Private ordinary functions
Function, document-path: Private ordinary functions
Function, entity-full-name: Private ordinary functions
Function, entity-id: Private ordinary functions
Function, headline: Private ordinary functions
Function, inner-reference-href: Private ordinary functions
Function, make-contents-plist: Private ordinary functions
Function, make-documentation: Public ordinary functions
Function, make-relavive-href: Private ordinary functions
Function, parse-common-lisp-entity: Private ordinary functions
Function, permalink: Private ordinary functions
Function, resolve-doc: Private ordinary functions
Function, static-href: Private ordinary functions
Function, write-html: Private ordinary functions

G
Generic Function, (setf document-childs): Private generic functions
Generic Function, code-block-code: Private generic functions
Generic Function, code-block-lang: Private generic functions
Generic Function, document-childs: Private generic functions
Generic Function, entity-arglist: Private generic functions
Generic Function, entity-description-class: Private generic functions
Generic Function, entity-name: Private generic functions
Generic Function, entity-package: Private generic functions
Generic Function, hyperspec-ref-spec: Private generic functions
Generic Function, inner-reference-id: Private generic functions
Generic Function, inner-reference-title: Private generic functions
Generic Function, show-description-title: Private generic functions
Generic Function, toctree-maxdepth: Private generic functions

H
headline: Private ordinary functions
hyperspec-ref-spec: Private generic functions
hyperspec-ref-spec: Private generic functions

I
inner-reference-href: Private ordinary functions
inner-reference-id: Private generic functions
inner-reference-id: Private generic functions
inner-reference-title: Private generic functions
inner-reference-title: Private generic functions

M
Macro, def-common-lisp-entity-role: Private macros
Macro, def-entity-description-directive: Private macros
Macro, with-sphinx-markup: Private macros
Macro, with-tag: Private macros
make-contents-plist: Private ordinary functions
make-documentation: Public ordinary functions
make-relavive-href: Private ordinary functions
Method, (setf document-childs): Private generic functions
Method, allowed-child-p: Public standalone methods
Method, code-block-code: Private generic functions
Method, code-block-lang: Private generic functions
Method, do-transforms: Private standalone methods
Method, document-childs: Private generic functions
Method, entity-arglist: Private generic functions
Method, entity-description-class: Private generic functions
Method, entity-name: Private generic functions
Method, entity-name: Private generic functions
Method, entity-package: Private generic functions
Method, entity-package: Private generic functions
Method, hyperspec-ref-spec: Private generic functions
Method, inner-reference-id: Private generic functions
Method, inner-reference-title: Private generic functions
Method, read-document: Public standalone methods
Method, read-document: Public standalone methods
Method, show-description-title: Private generic functions
Method, show-description-title: Private generic functions
Method, show-description-title: Private generic functions
Method, toctree-maxdepth: Private generic functions
Method, transform: Public standalone methods
Method, transform: Public standalone methods
Method, transform: Public standalone methods
Method, transforms: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods
Method, visit-node: Public standalone methods

P
parse-common-lisp-entity: Private ordinary functions
permalink: Private ordinary functions

R
read-document: Public standalone methods
read-document: Public standalone methods
resolve-doc: Private ordinary functions

S
show-description-title: Private generic functions
show-description-title: Private generic functions
show-description-title: Private generic functions
show-description-title: Private generic functions
static-href: Private ordinary functions

T
toctree-maxdepth: Private generic functions
toctree-maxdepth: Private generic functions
transform: Public standalone methods
transform: Public standalone methods
transform: Public standalone methods
transforms: Public standalone methods

V
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods
visit-node: Public standalone methods

W
with-sphinx-markup: Private macros
with-tag: Private macros
write-html: Private ordinary functions


A.3 Variables

Jump to:   *  
A   C   D   I   L   M   N   P   S   T  
Index Entry  Section

*
*api-reference-map*: Private special variables
*current-document*: Private special variables
*directives*: Private special variables
*inner-reference-map*: Private special variables
*interpreted-roles*: Private special variables
*root*: Private special variables
*root-path*: Private special variables
*verbose*: Private special variables

A
arglist: Private classes

C
childs: Private classes
code: Private classes

D
description-class: Private classes

I
id: Private classes

L
lang: Private classes

M
maxdepth: Private classes

N
name: Private classes
name: Private classes
next: Private classes

P
package: Private classes
package: Private classes
prev: Private classes

S
Slot, arglist: Private classes
Slot, childs: Private classes
Slot, code: Private classes
Slot, description-class: Private classes
Slot, id: Private classes
Slot, lang: Private classes
Slot, maxdepth: Private classes
Slot, name: Private classes
Slot, name: Private classes
Slot, next: Private classes
Slot, package: Private classes
Slot, package: Private classes
Slot, prev: Private classes
Slot, spec: Private classes
Slot, title: Private classes
spec: Private classes
Special Variable, *api-reference-map*: Private special variables
Special Variable, *current-document*: Private special variables
Special Variable, *directives*: Private special variables
Special Variable, *inner-reference-map*: Private special variables
Special Variable, *interpreted-roles*: Private special variables
Special Variable, *root*: Private special variables
Special Variable, *root-path*: Private special variables
Special Variable, *verbose*: Private special variables

T
title: Private classes


A.4 Data types

Jump to:   A   C   D   F   H   I   M   P   R   S   T   V   W  
Index Entry  Section

A
api-reference-map-transform: Private classes

C
cl.lisp: The sphinx/src/cl․lisp file
Class, api-reference-map-transform: Private classes
Class, code-block: Private classes
Class, common-lisp-entity: Private classes
Class, description: Private classes
Class, document: Private classes
Class, function-description: Private classes
Class, hyperspec-ref: Private classes
Class, inner-reference: Private classes
Class, inner-reference-map: Private classes
Class, macro-description: Private classes
Class, reader: Private classes
Class, resolve-static-files: Private classes
Class, sphinx-html-writer: Private classes
Class, toctree: Private classes
Class, variable-description: Private classes
code-block: Private classes
common-lisp-entity: Private classes

D
description: Private classes
document: Private classes
document.lisp: The sphinx/src/document․lisp file

F
File, cl.lisp: The sphinx/src/cl․lisp file
File, document.lisp: The sphinx/src/document․lisp file
File, packages.lisp: The sphinx/src/packages․lisp file
File, reader.lisp: The sphinx/src/reader․lisp file
File, ref.lisp: The sphinx/src/ref․lisp file
File, resolve.lisp: The sphinx/src/resolve․lisp file
File, sphinx.asd: The sphinx/sphinx․asd file
File, toctree.lisp: The sphinx/src/toctree․lisp file
File, writer.lisp: The sphinx/src/writer․lisp file
function-description: Private classes

H
hyperspec-ref: Private classes

I
inner-reference: Private classes
inner-reference-map: Private classes

M
macro-description: Private classes
Module, src: The sphinx/src module

P
Package, sphinx: The sphinx package
packages.lisp: The sphinx/src/packages․lisp file

R
reader: Private classes
reader.lisp: The sphinx/src/reader․lisp file
ref.lisp: The sphinx/src/ref․lisp file
resolve-static-files: Private classes
resolve.lisp: The sphinx/src/resolve․lisp file

S
sphinx: The sphinx system
sphinx: The sphinx package
sphinx-html-writer: Private classes
sphinx.asd: The sphinx/sphinx․asd file
src: The sphinx/src module
System, sphinx: The sphinx system

T
toctree: Private classes
toctree.lisp: The sphinx/src/toctree․lisp file

V
variable-description: Private classes

W
writer.lisp: The sphinx/src/writer․lisp file