This is the eazy-documentation Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:20:22 2024 GMT+0.
eazy-documentation/eazy-documentation.asdeazy-documentation/0package.lispeazy-documentation/1common.lispeazy-documentation/1definition.lispeazy-documentation/1raw-html.lispeazy-documentation/2extractor.lispeazy-documentation/3emitter.lispeazy-documentation/4user.lispeazy-documentation/5template.lispeazy-documentation/6main.lispThe main system appears first, followed by any subsystem dependency.
eazy-documentationOne-shot solution to the CL documentation generator.
Masataro Asai
LGPL
0.1
trivia (system).
alexandria (system).
iterate (system).
cl-ppcre (system).
trivia.ppcre (system).
common-doc (system).
common-html (system).
common-doc-split-paragraphs (system).
cl-who (system).
0package.lisp (file).
1common.lisp (file).
1definition.lisp (file).
1raw-html.lisp (file).
2extractor.lisp (file).
3emitter.lisp (file).
4user.lisp (file).
5template.lisp (file).
6main.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
eazy-documentation/eazy-documentation.asdeazy-documentation/0package.lispeazy-documentation/1common.lispeazy-documentation/1definition.lispeazy-documentation/1raw-html.lispeazy-documentation/2extractor.lispeazy-documentation/3emitter.lispeazy-documentation/4user.lispeazy-documentation/5template.lispeazy-documentation/6main.lispeazy-documentation/eazy-documentation.asdeazy-documentation (system).
eazy-documentation/0package.lispeazy-documentation (system).
list-all-define-macros (function).
note (function).
eazy-documentation/1common.lisp0package.lisp (file).
eazy-documentation (system).
*local-root* (special variable).
*remote-root* (special variable).
+doc+ (special variable).
+ignore+ (special variable).
+keywords+ (special variable).
basename (function).
copy-destination (function).
copy-to-dir (function).
dirname (function).
local-enough-namestring (function).
parse-key-arg (function).
remote-enough-namestring (function).
eazy-documentation/1definition.lisp1common.lisp (file).
eazy-documentation (system).
print-object (method).
args (reader method).
(setf args) (writer method).
def (class).
def= (function).
def~ (function).
def~doc (function).
docstring (reader method).
(setf docstring) (writer method).
doctype (reader method).
(setf doctype) (writer method).
file (reader method).
(setf file) (writer method).
left (function).
merge-slot (function).
name (reader method).
(setf name) (writer method).
name (type).
safe-name (function).
eazy-documentation/1raw-html.lisp1definition.lisp (file).
eazy-documentation (system).
convert-file-to-ascii-string (function).
convert-file-to-html-string (function).
convert-string-to-ascii-string (function).
convert-string-to-html-string (function).
eazy-documentation/2extractor.lisp1raw-html.lisp (file).
eazy-documentation (system).
*deferred-tasks* (special variable).
*defs* (special variable).
*old-macroexpand-hook* (special variable).
add-def (function).
call-with-extracting-definitions (function).
expand-extracting-definitions (function).
extract-definitions (function).
natural-language-string-p (function).
parse-def (function).
parse-setf (function).
remove-macro-lambda-list-keywords (function).
eazy-documentation/3emitter.lisp2extractor.lisp (file).
eazy-documentation (system).
*default-css* (special variable).
*default-fonts* (special variable).
*default-js* (special variable).
*ids* (special variable).
classes (function).
div (function).
entry-status (function).
fdiv (function).
generate-commondoc (function).
generate-commondoc-main (function).
insert-docstring (function).
list+ (function).
make-doc-entry (function).
make-entry (function).
par (function).
print-args (function).
print-package (function).
process-black-white-list (function).
render-html (function).
span (function).
span-id (function).
symbol-package-name-class (function).
symbol-status (function).
table-of-contents (function).
eazy-documentation/4user.lisp3emitter.lisp (file).
eazy-documentation (system).
extract-definitions-from-file (function).
extract-definitions-from-system (function).
generate-commondoc-from-file (function).
generate-commondoc-from-system (function).
generate-html (function).
generate-html-from-dir (function).
generate-html-from-file (function).
generate-html-from-system (function).
*supported-extensions* (special variable).
*target-pathname* (special variable).
augment-args-from-dir (function).
augment-args-from-file (function).
augment-args-from-system (function).
collect-static-files (function).
extract-definitions-from-dir (function).
extract-definitions-from-static-files (function).
strip/ (function).
eazy-documentation/5template.lisp4user.lisp (file).
eazy-documentation (system).
render (method).
render-section (method).
eazy-template (class).
eazy-documentation/6main.lisp5template.lisp (file).
eazy-documentation (system).
main (function).
Packages are listed by definition order.
eazy-documentationThis package provides an easy way to extract documentations from
a lisp source code.
Advantages over the existing libraries:
* EAZY-DOCUMENTATION can generate documents from a single file or an ASDF system.
Run ‘(eazy-documentation:generate-html <file-or-system> "index.html")‘
No additional quirks are necessary.
* Extraction is heuristic and robust. It is easily automated and can handle
unknown user-defined macro whose name begins with DEF.
* As per Quickdocs, it respects the file and directory structure. Well-written, maintainable
libraries have a great readability in the source code. This should be respected
and the documentation generator should respect this structure.
* It minimizes the clutter in the auto-generateded output by detecting and
grouping the similar documentation entries.
For example, these entries are grouped together:
* Functions with the same lambda-list and docstrings.
* Variables with the same docstrings.
* Any DEF-something macro entries with the same name and missing documentations.
* Typesetting and syntax highlighting of docstring is done by
[Pandoc](https://pandoc.org/) which supports a wide range of language and
format support.
Run ‘curl -sSL https://get.haskellstack.org/ | sh && stack install pandoc‘
to install the latest Pandoc.
* The output is a common-doc object, thus easily pluggable to the existing emitter
for them.
alexandria.
common-doc.
common-lisp.
iterate.
trivia.level2.
convert-file-to-ascii-string (function).
convert-file-to-html-string (function).
convert-string-to-ascii-string (function).
convert-string-to-html-string (function).
extract-definitions-from-file (function).
extract-definitions-from-system (function).
generate-commondoc-from-file (function).
generate-commondoc-from-system (function).
generate-html (function).
generate-html-from-dir (function).
generate-html-from-file (function).
generate-html-from-system (function).
main (function).
*default-css* (special variable).
*default-fonts* (special variable).
*default-js* (special variable).
*deferred-tasks* (special variable).
*defs* (special variable).
*ids* (special variable).
*local-root* (special variable).
*old-macroexpand-hook* (special variable).
*remote-root* (special variable).
*supported-extensions* (special variable).
*target-pathname* (special variable).
+doc+ (special variable).
+ignore+ (special variable).
+keywords+ (special variable).
add-def (function).
args (generic reader).
(setf args) (generic writer).
augment-args-from-dir (function).
augment-args-from-file (function).
augment-args-from-system (function).
basename (function).
call-with-extracting-definitions (function).
classes (function).
collect-static-files (function).
copy-destination (function).
copy-to-dir (function).
def (class).
def= (function).
def~ (function).
def~doc (function).
dirname (function).
div (function).
docstring (generic reader).
(setf docstring) (generic writer).
doctype (generic reader).
(setf doctype) (generic writer).
eazy-template (class).
entry-status (function).
expand-extracting-definitions (function).
extract-definitions (function).
extract-definitions-from-dir (function).
extract-definitions-from-static-files (function).
fdiv (function).
file (generic reader).
(setf file) (generic writer).
generate-commondoc (function).
generate-commondoc-main (function).
insert-docstring (function).
left (function).
list+ (function).
list-all-define-macros (function).
local-enough-namestring (function).
make-doc-entry (function).
make-entry (function).
merge-slot (function).
name (generic reader).
(setf name) (generic writer).
name (type).
natural-language-string-p (function).
note (function).
par (function).
parse-def (function).
parse-key-arg (function).
parse-setf (function).
print-args (function).
print-package (function).
process-black-white-list (function).
remote-enough-namestring (function).
remove-macro-lambda-list-keywords (function).
render-html (function).
safe-name (function).
span (function).
span-id (function).
strip/ (function).
symbol-package-name-class (function).
symbol-status (function).
table-of-contents (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
eazy-template) (document document) content-string) ¶The simplest template.
common-html.template.
eazy-template) (document document) (section section) content-string) ¶The simplest section template.
common-html.template.
A list of CSS stylesheet pathnames to be loaded in the html by default.
A list of strings for Google font name
A list of JavaScript pathnames to be loaded in the html by default.
A list of thunks. Each thunk contains code to extract the docstring after loading the system.
This variable is mainly used for parsing (setf (documentation ...)) forms
because the docstring may not be available in the macro expansion time unlike macros such as DEFUN.
the list of supported extensions scraped by eazy-documentation
Declare statement that says ignorable for the keyword arguments in +keywords+.
The list of keyword argument list shared by several functions.
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Supply missing command-line arguments using file information
Supply missing command-line arguments using system information
path/to/dir/file -> file
Compare the name and the doctype. Returns true when they are both EQ.
Compare the name (and its package), doctype, file, args, docstring. Returns true when they look same according to a heuristic rule.
Compare the file and docstring.
Returns true when they are both missing or EQUAL.
path/to/dir/file -> path/to/dir
use uiop:pathname-directory-pathanme when you need path/to/dir/
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
force making a div – make-content may omit them if it lacks classes
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Print a list of all macros in the current lisp image whose name starts with DEF.
Heuristic decision to prune non-docstring
A custom format variant for printing a note while eazy-documentation is processing a file.
remove &whole and &env from a lambda list
Options:
| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |
Create a span element with an id based on SYM.
Extract a tree of document links representing the table of contents of a
document. All the sections in the document must have references, so you should
call fill-unique-refs first.
Completely rewritten from common-html because it infers the depth incorrectly.
Instances represententing a documentation entry.
symbol
:doctype
string
:docstring
template.
list
eazy-documentation::*default-css*
:css-list
list
eazy-documentation::*default-fonts*
:font-list
list
eazy-documentation::*default-js*
:js-list
| Jump to: | (
A B C D E F G I L M N P R S T |
|---|
| Jump to: | (
A B C D E F G I L M N P R S T |
|---|
| Jump to: | *
+
A C D F J N S |
|---|
| Jump to: | *
+
A C D F J N S |
|---|
| Jump to: | 0
1
2
3
4
5
6
C D E F N P S T |
|---|
| Jump to: | 0
1
2
3
4
5
6
C D E F N P S T |
|---|