The sphinx Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The sphinx Reference Manual

This is the sphinx Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:24:10 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 sphinx

Dependencies
Source

sphinx.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

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


Previous: , Up: Modules   [Contents][Index]

2.1 sphinx/src

Parent

sphinx (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 sphinx.asd

Location

sphinx.asd

Systems

sphinx (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 sphinx/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

sphinx


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 sphinx/src/document.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/document.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 sphinx/src/toctree.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/toctree.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 sphinx/src/ref.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/ref.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 sphinx/src/resolve.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/resolve.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 sphinx/src/cl.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/cl.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 sphinx/src/reader.lisp

Dependency

toctree.lisp (file)

Parent

src (module)

Location

src/reader.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.9 sphinx/src/writer.lisp

Dependencies
Parent

src (module)

Location

src/writer.lisp

Exported Definitions

make-documentation (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 sphinx

Source

packages.lisp (file)

Use List
Exported Definitions

make-documentation (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: make-documentation CONTENTS TARGET-DIR &key VERBOSE
Package

sphinx

Source

writer.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *api-reference-map*
Package

sphinx

Source

cl.lisp (file)

Special Variable: *current-document*
Package

sphinx

Source

document.lisp (file)

Special Variable: *directives*
Package

sphinx

Source

document.lisp (file)

Special Variable: *inner-reference-map*
Package

sphinx

Source

ref.lisp (file)

Special Variable: *interpreted-roles*
Package

sphinx

Source

document.lisp (file)

Special Variable: *root*
Package

sphinx

Source

document.lisp (file)

Special Variable: *root-path*
Package

sphinx

Source

document.lisp (file)

Special Variable: *verbose*
Package

sphinx

Source

reader.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: def-common-lisp-entity-role NAME &optional DESCRIPTION-CLASS
Package

sphinx

Source

cl.lisp (file)

Macro: def-entity-description-directive DIRECTIVE CLASS
Package

sphinx

Source

cl.lisp (file)

Macro: with-sphinx-markup &body BODY
Package

sphinx

Source

document.lisp (file)

Macro: with-tag (TAG &optional CLASS) &body BODY
Package

sphinx

Source

cl.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: api-reference-href NODE &aux DCLASS
Package

sphinx

Source

cl.lisp (file)

Function: compile-template PATH
Package

sphinx

Source

writer.lisp (file)

Function: document-childs-recursively DOC
Package

sphinx

Source

document.lisp (file)

Function: document-name DOC
Package

sphinx

Source

document.lisp (file)

Function: document-path DOC
Package

sphinx

Source

document.lisp (file)

Function: entity-full-name ENTITY
Package

sphinx

Source

cl.lisp (file)

Function: entity-id ENTITY
Package

sphinx

Source

cl.lisp (file)

Function: headline NODE H
Package

sphinx

Source

writer.lisp (file)

Function: inner-reference-href NODE
Package

sphinx

Source

ref.lisp (file)

Function: make-contents-plist DOC
Package

sphinx

Source

writer.lisp (file)

Function: make-relavive-href HREF BASE
Package

sphinx

Source

resolve.lisp (file)

Function: parse-common-lisp-entity STR
Package

sphinx

Source

cl.lisp (file)

Function: permalink ID &optional TITLE
Package

sphinx

Source

cl.lisp (file)

Function: resolve-doc DOC BASE
Package

sphinx

Source

resolve.lisp (file)

Function: static-href NAME
Package

sphinx

Source

resolve.lisp (file)

Function: write-html DOC PATH TEMPLATE
Package

sphinx

Source

writer.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: code-block-code OBJECT
Package

sphinx

Methods
Method: code-block-code (CODE-BLOCK code-block)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: code-block-lang OBJECT
Package

sphinx

Methods
Method: code-block-lang (CODE-BLOCK code-block)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: document-childs OBJECT
Generic Function: (setf document-childs) NEW-VALUE OBJECT
Package

sphinx

Methods
Method: document-childs (DOCUMENT document)

automatically generated reader method

Source

document.lisp (file)

Method: (setf document-childs) NEW-VALUE (DOCUMENT document)

automatically generated writer method

Source

document.lisp (file)

Generic Function: entity-arglist OBJECT
Package

sphinx

Methods
Method: entity-arglist (DESCRIPTION description)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: entity-description-class OBJECT
Package

sphinx

Methods
Method: entity-description-class (COMMON-LISP-ENTITY common-lisp-entity)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: entity-name OBJECT
Package

sphinx

Methods
Method: entity-name (COMMON-LISP-ENTITY common-lisp-entity)

automatically generated reader method

Source

cl.lisp (file)

Method: entity-name (DESCRIPTION description)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: entity-package OBJECT
Package

sphinx

Methods
Method: entity-package (COMMON-LISP-ENTITY common-lisp-entity)

automatically generated reader method

Source

cl.lisp (file)

Method: entity-package (DESCRIPTION description)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: hyperspec-ref-spec OBJECT
Package

sphinx

Methods
Method: hyperspec-ref-spec (HYPERSPEC-REF hyperspec-ref)

automatically generated reader method

Source

cl.lisp (file)

Generic Function: inner-reference-id OBJECT
Package

sphinx

Methods
Method: inner-reference-id (INNER-REFERENCE inner-reference)

automatically generated reader method

Source

ref.lisp (file)

Generic Function: inner-reference-title OBJECT
Package

sphinx

Methods
Method: inner-reference-title (INNER-REFERENCE inner-reference)

automatically generated reader method

Source

ref.lisp (file)

Generic Function: show-description-title ENTITY
Package

sphinx

Source

cl.lisp (file)

Methods
Method: show-description-title (ENTITY variable-description)
Method: show-description-title ENTITY around
Method: show-description-title ENTITY
Generic Function: toctree-maxdepth OBJECT
Package

sphinx

Methods
Method: toctree-maxdepth (TOCTREE toctree)

automatically generated reader method

Source

toctree.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

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

sphinx

Source

cl.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

Class: code-block ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

raw (class)

Direct methods
Direct slots
Slot: lang
Initargs

:lang

Readers

code-block-lang (generic function)

Slot: code
Initargs

:code

Readers

code-block-code (generic function)

Class: common-lisp-entity ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

raw (class)

Direct methods
Direct slots
Slot: package
Initargs

:package

Readers

entity-package (generic function)

Slot: name
Initargs

:name

Readers

entity-name (generic function)

Slot: description-class
Initargs

:description-class

Readers

entity-description-class (generic function)

Class: description ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

raw (class)

Direct subclasses
Direct methods
Direct slots
Slot: package
Initargs

:package

Readers

entity-package (generic function)

Slot: name
Initargs

:name

Readers

entity-name (generic function)

Slot: arglist
Initargs

:arglist

Readers

entity-arglist (generic function)

Class: document ()
Package

sphinx

Source

document.lisp (file)

Direct superclasses

document (class)

Direct methods
Direct slots
Slot: prev
Slot: next
Slot: childs
Readers

document-childs (generic function)

Writers

(setf document-childs) (generic function)

Class: function-description ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

description (class)

Class: hyperspec-ref ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

raw (class)

Direct methods
Direct slots
Slot: spec
Initargs

:spec

Readers

hyperspec-ref-spec (generic function)

Class: inner-reference ()
Package

sphinx

Source

ref.lisp (file)

Direct superclasses

raw (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

inner-reference-id (generic function)

Slot: title
Initargs

:title

Readers

inner-reference-title (generic function)

Class: inner-reference-map ()

Fill *inner-reference-map*

Package

sphinx

Source

ref.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

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

sphinx

Source

cl.lisp (file)

Direct superclasses

description (class)

Class: reader ()
Package

sphinx

Source

reader.lisp (file)

Direct superclasses

rst-reader (class)

Direct methods
  • read-document (method)
  • read-document (method)
  • transforms (method)
Class: resolve-static-files ()

Resolve static dependancies

Package

sphinx

Source

resolve.lisp (file)

Direct superclasses

transform (class)

Direct methods

transform (method)

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

sphinx

Source

writer.lisp (file)

Direct superclasses

html-writer (class)

Direct methods
  • visit-node (method)
  • visit-node (method)
Class: toctree ()
Package

sphinx

Source

toctree.lisp (file)

Direct superclasses

paragraph (class)

Direct methods
Direct slots
Slot: maxdepth
Initargs

:maxdepth

Initform

1

Readers

toctree-maxdepth (generic function)

Class: variable-description ()
Package

sphinx

Source

cl.lisp (file)

Direct superclasses

description (class)

Direct methods

show-description-title (method)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, sphinx.asd: The sphinx<dot>asd file
File, Lisp, sphinx/src/cl.lisp: The sphinx/src/cl<dot>lisp file
File, Lisp, sphinx/src/document.lisp: The sphinx/src/document<dot>lisp file
File, Lisp, sphinx/src/packages.lisp: The sphinx/src/packages<dot>lisp file
File, Lisp, sphinx/src/reader.lisp: The sphinx/src/reader<dot>lisp file
File, Lisp, sphinx/src/ref.lisp: The sphinx/src/ref<dot>lisp file
File, Lisp, sphinx/src/resolve.lisp: The sphinx/src/resolve<dot>lisp file
File, Lisp, sphinx/src/toctree.lisp: The sphinx/src/toctree<dot>lisp file
File, Lisp, sphinx/src/writer.lisp: The sphinx/src/writer<dot>lisp file

L
Lisp File, sphinx.asd: The sphinx<dot>asd file
Lisp File, sphinx/src/cl.lisp: The sphinx/src/cl<dot>lisp file
Lisp File, sphinx/src/document.lisp: The sphinx/src/document<dot>lisp file
Lisp File, sphinx/src/packages.lisp: The sphinx/src/packages<dot>lisp file
Lisp File, sphinx/src/reader.lisp: The sphinx/src/reader<dot>lisp file
Lisp File, sphinx/src/ref.lisp: The sphinx/src/ref<dot>lisp file
Lisp File, sphinx/src/resolve.lisp: The sphinx/src/resolve<dot>lisp file
Lisp File, sphinx/src/toctree.lisp: The sphinx/src/toctree<dot>lisp file
Lisp File, sphinx/src/writer.lisp: The sphinx/src/writer<dot>lisp file

M
Module, sphinx/src: The sphinx/src module

S
sphinx.asd: The sphinx<dot>asd file
sphinx/src: The sphinx/src module
sphinx/src/cl.lisp: The sphinx/src/cl<dot>lisp file
sphinx/src/document.lisp: The sphinx/src/document<dot>lisp file
sphinx/src/packages.lisp: The sphinx/src/packages<dot>lisp file
sphinx/src/reader.lisp: The sphinx/src/reader<dot>lisp file
sphinx/src/ref.lisp: The sphinx/src/ref<dot>lisp file
sphinx/src/resolve.lisp: The sphinx/src/resolve<dot>lisp file
sphinx/src/toctree.lisp: The sphinx/src/toctree<dot>lisp file
sphinx/src/writer.lisp: The sphinx/src/writer<dot>lisp file

Jump to:   F   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

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

A
api-reference-href: Internal functions

C
code-block-code: Internal generic functions
code-block-code: Internal generic functions
code-block-lang: Internal generic functions
code-block-lang: Internal generic functions
compile-template: Internal functions

D
def-common-lisp-entity-role: Internal macros
def-entity-description-directive: Internal macros
document-childs: Internal generic functions
document-childs: Internal generic functions
document-childs-recursively: Internal functions
document-name: Internal functions
document-path: Internal functions

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

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

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

H
headline: Internal functions
hyperspec-ref-spec: Internal generic functions
hyperspec-ref-spec: Internal generic functions

I
inner-reference-href: Internal functions
inner-reference-id: Internal generic functions
inner-reference-id: Internal generic functions
inner-reference-title: Internal generic functions
inner-reference-title: Internal generic functions

M
Macro, def-common-lisp-entity-role: Internal macros
Macro, def-entity-description-directive: Internal macros
Macro, with-sphinx-markup: Internal macros
Macro, with-tag: Internal macros
make-contents-plist: Internal functions
make-documentation: Exported functions
make-relavive-href: Internal functions
Method, (setf document-childs): Internal generic functions
Method, code-block-code: Internal generic functions
Method, code-block-lang: Internal generic functions
Method, document-childs: Internal generic functions
Method, entity-arglist: Internal generic functions
Method, entity-description-class: Internal generic functions
Method, entity-name: Internal generic functions
Method, entity-name: Internal generic functions
Method, entity-package: Internal generic functions
Method, entity-package: Internal generic functions
Method, hyperspec-ref-spec: Internal generic functions
Method, inner-reference-id: Internal generic functions
Method, inner-reference-title: Internal generic functions
Method, show-description-title: Internal generic functions
Method, show-description-title: Internal generic functions
Method, show-description-title: Internal generic functions
Method, toctree-maxdepth: Internal generic functions

P
parse-common-lisp-entity: Internal functions
permalink: Internal functions

R
resolve-doc: Internal functions

S
show-description-title: Internal generic functions
show-description-title: Internal generic functions
show-description-title: Internal generic functions
show-description-title: Internal generic functions
static-href: Internal functions

T
toctree-maxdepth: Internal generic functions
toctree-maxdepth: Internal generic functions

W
with-sphinx-markup: Internal macros
with-tag: Internal macros
write-html: Internal functions

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

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

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

A
arglist: Internal classes

C
childs: Internal classes
code: Internal classes

D
description-class: Internal classes

I
id: Internal classes

L
lang: Internal classes

M
maxdepth: Internal classes

N
name: Internal classes
name: Internal classes
next: Internal classes

P
package: Internal classes
package: Internal classes
prev: Internal classes

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

T
title: Internal classes

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

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

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

A
api-reference-map-transform: Internal classes

C
Class, api-reference-map-transform: Internal classes
Class, code-block: Internal classes
Class, common-lisp-entity: Internal classes
Class, description: Internal classes
Class, document: Internal classes
Class, function-description: Internal classes
Class, hyperspec-ref: Internal classes
Class, inner-reference: Internal classes
Class, inner-reference-map: Internal classes
Class, macro-description: Internal classes
Class, reader: Internal classes
Class, resolve-static-files: Internal classes
Class, sphinx-html-writer: Internal classes
Class, toctree: Internal classes
Class, variable-description: Internal classes
code-block: Internal classes
common-lisp-entity: Internal classes

D
description: Internal classes
document: Internal classes

F
function-description: Internal classes

H
hyperspec-ref: Internal classes

I
inner-reference: Internal classes
inner-reference-map: Internal classes

M
macro-description: Internal classes

P
Package, sphinx: The sphinx package

R
reader: Internal classes
resolve-static-files: Internal classes

S
sphinx: The sphinx system
sphinx: The sphinx package
sphinx-html-writer: Internal classes
System, sphinx: The sphinx system

T
toctree: Internal classes

V
variable-description: Internal classes

Jump to:   A   C   D   F   H   I   M   P   R   S   T   V