Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the codex Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:17:46 2022 GMT+0.
Next: Systems, Previous: The codex Reference Manual, Up: The codex Reference Manual [Contents][Index]
A documentation system for Common Lisp.
Codex generates documentation. You just write docstrings as usual, only using Scriba syntax, append a couple of extra files (A few tutorials and what have you), and Codex creates beautiful online documentation, and in the near future, PDF manuals.
See the documentation
Copyright (c) 2014-2015 Fernando Borretti
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: The codex Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: codex-templates, Previous: Systems, Up: Systems [Contents][Index]
A documentation system for Common Lisp.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:CommonDoc/codex.git)
MIT
# Codex
[](https://travis-ci.org/CommonDoc/codex)
[](https://coveralls.io/r/CommonDoc/codex?branch=master)
A documentation system for Common Lisp.
# Overview
**Codex** generates documentation. You just write docstrings as usual, only
using [Scriba][scriba] syntax, append a couple of extra files (A few tutorials
and what have you), and Codex creates beautiful online documentation, and in the
near future, PDF manuals.
See the [documentation][docs]
# License
Copyright (c) 2014-2015 Fernando Borretti
Licensed under the MIT License.
[scriba]: https://github.com/CommonDoc/scriba
[docs]: http://commondoc.github.io/codex/docs/overview.html
0.2
src (module).
Templates for Codex.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
MIT
0.1
templates (module).
Next: Files, Previous: Systems, Up: The codex Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: codex-templates/templates, Previous: Modules, Up: Modules [Contents][Index]
codex (system).
Next: codex-templates/templates/static, Previous: codex/src, Up: Modules [Contents][Index]
codex-templates (system).
Next: codex-templates/templates/minima, Previous: codex-templates/templates, Up: Modules [Contents][Index]
templates.lisp (file).
templates (module).
Next: codex-templates/templates/gamma, Previous: codex-templates/templates/static, Up: Modules [Contents][Index]
static (module).
templates (module).
Next: codex-templates/templates/traditional, Previous: codex-templates/templates/minima, Up: Modules [Contents][Index]
minima (module).
templates (module).
Previous: codex-templates/templates/gamma, Up: Modules [Contents][Index]
gamma (module).
templates (module).
Next: Packages, Previous: Modules, Up: The codex Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: codex-templates/codex-templates.asd, Previous: Lisp, Up: Lisp [Contents][Index]
Next: codex/src/error.lisp, Previous: codex/codex.asd, Up: Lisp [Contents][Index]
codex-templates (system).
Next: codex/src/markup.lisp, Previous: codex-templates/codex-templates.asd, Up: Lisp [Contents][Index]
src (module).
Next: codex/src/manifest.lisp, Previous: codex/src/error.lisp, Up: Lisp [Contents][Index]
error.lisp (file).
src (module).
Next: codex/src/macro.lisp, Previous: codex/src/markup.lisp, Up: Lisp [Contents][Index]
markup.lisp (file).
src (module).
Next: codex/src/codex.lisp, Previous: codex/src/manifest.lisp, Up: Lisp [Contents][Index]
manifest.lisp (file).
src (module).
Next: codex/src/quickstart.lisp, Previous: codex/src/macro.lisp, Up: Lisp [Contents][Index]
macro.lisp (file).
src (module).
Next: codex-templates/templates/templates.lisp, Previous: codex/src/codex.lisp, Up: Lisp [Contents][Index]
codex.lisp (file).
src (module).
quickstart (function).
Previous: codex/src/quickstart.lisp, Up: Lisp [Contents][Index]
templates (module).
Next: codex-templates/templates/static/reset.css, Previous: Static, Up: Static [Contents][Index]
static (module).
Next: codex-templates/templates/minima/base.html, Previous: codex-templates/templates/static/nodes.css, Up: Static [Contents][Index]
static (module).
Next: codex-templates/templates/minima/document.html, Previous: codex-templates/templates/static/reset.css, Up: Static [Contents][Index]
minima (module).
Next: codex-templates/templates/minima/section.html, Previous: codex-templates/templates/minima/base.html, Up: Static [Contents][Index]
minima (module).
Next: codex-templates/templates/minima/style.css, Previous: codex-templates/templates/minima/document.html, Up: Static [Contents][Index]
minima (module).
Next: codex-templates/templates/gamma/base.html, Previous: codex-templates/templates/minima/section.html, Up: Static [Contents][Index]
minima (module).
Next: codex-templates/templates/gamma/document.html, Previous: codex-templates/templates/minima/style.css, Up: Static [Contents][Index]
gamma (module).
Next: codex-templates/templates/gamma/section.html, Previous: codex-templates/templates/gamma/base.html, Up: Static [Contents][Index]
gamma (module).
Next: codex-templates/templates/gamma/style.css, Previous: codex-templates/templates/gamma/document.html, Up: Static [Contents][Index]
gamma (module).
Next: codex-templates/templates/traditional/base.html, Previous: codex-templates/templates/gamma/section.html, Up: Static [Contents][Index]
gamma (module).
Next: codex-templates/templates/traditional/document.html, Previous: codex-templates/templates/gamma/style.css, Up: Static [Contents][Index]
traditional (module).
Next: codex-templates/templates/traditional/section.html, Previous: codex-templates/templates/traditional/base.html, Up: Static [Contents][Index]
traditional (module).
Next: codex-templates/templates/traditional/style.css, Previous: codex-templates/templates/traditional/document.html, Up: Static [Contents][Index]
traditional (module).
Previous: codex-templates/templates/traditional/section.html, Up: Static [Contents][Index]
traditional (module).
Next: Definitions, Previous: Files, Up: The codex Reference Manual [Contents][Index]
Packages are listed by definition order.
Codex errors.
common-lisp.
Next: codex.tmpl, Previous: codex.error, Up: Packages [Contents][Index]
The main interface.
common-lisp.
Next: codex.markup, Previous: codex, Up: Packages [Contents][Index]
Codex template definitions.
Next: codex.macro, Previous: codex.tmpl, Up: Packages [Contents][Index]
Parsing files and docstrings.
common-lisp.
Next: codex-manifest-user, Previous: codex.markup, Up: Packages [Contents][Index]
CommonDoc macros for Codex.
common-lisp.
Next: codex.manifest, Previous: codex.macro, Up: Packages [Contents][Index]
The package in which Codex manifests are read.
Previous: codex-manifest-user, Up: Packages [Contents][Index]
Parsing Codex manifest files.
common-lisp.
Next: Indexes, Previous: Packages, Up: The codex Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
The name of the markup format that will be used to parse docstrings and files. This is a keyword that is passed to Pandocl.
The pathname of the Codex manifest in a system.
The current Docparser index.
If this variable is not NIL, do not call a debugger when undocumented node is found.
A hash table of table names (Keywords) to template classes.
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Generate documentation for a system. @c(skip-undocumented) overrides @c(*skip-undocumented*) @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")
Find a template by name.
Parse a manifest from a pathname.
Parse a docstring into a documentation node using the current markup format.
Create a documentation folder, manifest, and a sample file for the given system.
Return the absolute pathname to a system’s Codex manifest. @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
A list of the document’s authors.
node.
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
common-doc.macro.
Copy the template’s static files to the output directory
Render a built-in document template.
common-html.template.
Render a built-in section template.
common-html.template.
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
The base class of all Codex errors.
condition.
Signalled when there is an error parsing a manifest file.
The name of the system.
:system-name
This slot is read-only.
Signalled when a node has no docstring.
node.
Signalled by errors related to templates.
The template name.
:template-name
This slot is read-only.
Signalled when Codex doesn’t know the output format a document specifies.
The name of the output format.
:format-name
This slot is read-only.
Previous: Conditions, Up: Public Interface [Contents][Index]
A convenience subclass for Codex built-in templates. These
slots are not built into the default codex-template class, since users might
define their own templates without using this machinery.
Insert documentation of a node.
macro-node.
Codex templates.
template.
The directory where the output will be produced.
pathname
:output-directory
This slot is read-only.
A Codex document. Project manifests can define multiple documents, e.g. a manual, a tutorial, an advanced manual.
The document’s title.
string
:title
This slot is read-only.
A list of the document’s authors.
(trivial-types:proper-list string)
:authors
This slot is read-only.
The document’s output format.
codex.manifest:output-format
:output-format
This slot is read-only.
A list of pathnames to source files to build the document from.
(trivial-types:proper-list pathname)
:sources
This slot is read-only.
The base class of HTML formats.
The name of the HTML template.
keyword
:template-name
This slot is read-only.
A property list of template initargs.
trivial-types:property-list
:template-options
This slot is read-only.
Manifest options.
The markup format used in docstrings.
keyword
:markup-format
This slot is read-only.
A list of systems to document.
(trivial-types:proper-list keyword)
:systems
This slot is read-only.
A list of documents.
(trivial-types:proper-list codex.manifest:document)
:documents
This slot is read-only.
An argument of an operator.
macro-node.
Add a link to the Common Lisp HyperSpec.
macro-node.
Set the current package to use in the body.
macro-node.
The package’s name.
string
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
The name of the current package. Set by the with-package macro.
List of undocumented nodes
Associate the string names of Docparser classes to the corresponding docparser class names.
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
Build a document.
Build a manifest. Return a list of nodes which do not have a docstring.
Check and return the node’s docstring.
If there is none, codex.error:no-docstring condition is signalled.
Copy all the images from a CommonDoc document.
Create a node representing a node’s docstring.
Expand a generic operator node. Called by more specific methods.
Load a CommonDoc document from the sources of a Codex document.
Create metadata for HTML classes.
Parse a manifest’s document plist into a document object.
Create an instance of an output-format class from a plist.
Read a manifest file into an S-expression using the :codex-manifest-user package.
Handle undocumented nodes
Return the Hyperspec or l1sp.org URL for a symbol in the CL package.
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
Turn a Docparser node into a CommonDoc one.
When expanding an unsupported node, rather than generate an error, simply create an error message.
Expand a type node.
Backup method when someone has created a subclass of documentation-node that’s not explicitly supported by this.
Expand a variable node.
Expand a condition definition node.
Expand a class definition node.
Expand a structure definition node.
Expand a class slot node.
Expand a structure slot node. This doesn’t have any docstrings.
Backup method when someone has created a subclass of operator-node that’s not explicitly supported by this method.
Expand a method node.
Expand a generic function node.
Expand a macro node.
Expand a function node.
Create a node representing the name of a node. If it is a setf operation, "setf " is automatically prepended before the name text.
A plist of template options.
The directory where the output will be produced.
The package’s name.
name.
Previous: Definitions, Up: The codex Reference Manual [Contents][Index]
Jump to: | B C D E F G I L M N O P Q R S T U W |
---|
Jump to: | B C D E F G I L M N O P Q R S T U W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
+
D F H M N O S T |
---|
Jump to: | *
+
D F H M N O S T |
---|
Jump to: | B C D E F G H M N O P Q R S T U W |
---|
Jump to: | B C D E F G H M N O P Q R S T U W |
---|