[REL] CLOD - autodoc that targets Emacs org-mode
Posted: Fri Feb 12, 2010 5:53 am
Hi,
Announcing .... the first release of CLOD.
CLOD is an autodocumentation facility for CL. Its output is in "org" format -- the wiki-like markup language used by the powerful Emacs major mode, Org mode. It is trivial to export the resulting org mode file to HTML or a number of other formats from within Emacs.
CLOD is at:
http://bitbucket.org/eeeickythump/clod/
Tested extensively in Clozure CL, and briefly in SBCL and CLISP.
Example output (generated from CLOD itself): clod-doc.org
The same file exported to HTML: clod-doc.html
Targetting org mode allows CLOD to easily provide a robust and very readable markup language for docstrings, along with some uncommon features, such as syntax highlighting of lisp source in HTML.
Comments welcome!
Announcing .... the first release of CLOD.
CLOD is an autodocumentation facility for CL. Its output is in "org" format -- the wiki-like markup language used by the powerful Emacs major mode, Org mode. It is trivial to export the resulting org mode file to HTML or a number of other formats from within Emacs.
CLOD is at:
http://bitbucket.org/eeeickythump/clod/
Tested extensively in Clozure CL, and briefly in SBCL and CLISP.
Example output (generated from CLOD itself): clod-doc.org
The same file exported to HTML: clod-doc.html
Targetting org mode allows CLOD to easily provide a robust and very readable markup language for docstrings, along with some uncommon features, such as syntax highlighting of lisp source in HTML.
Comments welcome!