.. cl:package:: sphinxcontrib.cldomain.doc

Variables
---------

.. rst:directive::  .. cl:variable:: symbol-name

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

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

Code
~~~~
.. code-block:: common-lisp

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

Output
~~~~~~
.. cl:variable:: *example-variable*

.. _variable2:

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
~~~~
.. code-block:: common-lisp

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

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

   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.