Variables

.. cl:variable:: symbol-name

The cl:variable directive will resolve the arguments and documentation from the common lisp definition:

.. cl:variable:: *example-variable*

Code

(defvar *example-variable* "value"
  "This is an example variable.")

Output

Variable *example-variable*

This is an example variable.

You can include additional text, which appears after the docstring (unless you use the :nodoc: option):

.. cl:variable:: *example-variable-2*

   This variable requires more explanitory text after its docstring. Because,
   more text means more clarity and further explains the intent of the original
   software developer.

Code

(defvar *example-variable-2* "another value"
  "This example has additional text.")

Output

Variable *example-variable-2*

This example has additional text.

This variable requires more explanatory text after its docstring. Because, more text means more clarity and further explains the intent of the original software developer.