sphinxcontrib-cldomain 0.2

Sphinx domain for Common Lisp

CLDomain

CLDomain is a Common Lisp domain for Sphinx Documentation Generator. Sphinx is a mulit-language tool this project extends it’s functionality to cover Common Lisp. The aim is to support documentation with the same ease that a Python project.

Currently the project only supports inspection based documentation of symbols, future versions will allow more manual creation of documentation sections.

CLDomain is licensed under the GPLv3. Please report any bugs in the GitHub Bug Tracker.

An example of the generated documentation can be found in the cl-git project.

The current sample of a function definition looks like

.. cl:function:: ensure-git-repository-exist

   :param path: the path to the git repository.
   :param bare: if truthful, then create a bare repository.

   .. code-block:: common-lisp

      CL-GIT> (ensure-git-repository-exist #p"/tmp/test-repo/")
      #P"/tmp/test-repo/"

and the rendered example shows the documentation string has been introspected and so has the function definition.

Changelog

Release 0.2 14//04/2013

• link between generics and specializers.

• ignore symbols in documentation if they are in the arg list.

• better Quicklisp support.

• handling of symbols that boarder on punctuation.

Release 0.1 UNRELEASED

• initial prototype