Documenting Emacs Lisp symbols¶
This page introduces the Emacs Lisp domain and its directives and roles to document and cross-reference Emacs Lisp symbols.
Please read Sphinx Domains in the Sphinx documentation for more information on the concept of domains.
The Emacs Lisp domain¶
These directives live in the el domain.
You can set this domain as default domain to refer to the directives and roles without the el: prefix. To change the default domain globally, set the configuration value primary_domain in your conf.py accordingly:
primary_domain = 'el'
To change the default domain per file, use the default-domain directive:
.. default-domain:: el
All directives support some common options:
- Suppress the creation of an index entry. See Documenting interactive commands for an example of using this directive.
Insert the docstring extracted from the Emacs Lisp source code of this symbol.
For function-like symbols, also use the extracted function signature. For variables, also insert various various variable properties, such as whether the variable is safe as buffer local variable, whether it is automatically buffer local, etc.
Generally, the output of this option closely mirrors the appearance of docstrings in Emacs’ built-in Help Mode.
See Extracting docstrings of Emacs Lisp symbols for more information about automatically extracting docstrings.
An Emacs Lisp symbol can be defined in different “scopes”:
(defvar hello "Hello") (defun hello (name) (message "%s %s" hello name))
This defines hello as variable and as function. You can document these two definitions independently with the appropriate directives:
.. el:defvar:: hello .. el:function:: hello
Documenting functions and macros¶
- .. el:function:: symbol [argument ...] [&optional optional ...] [&rest args]¶
- .. el:macro:: symbol [argument ...] [&optional optional ...] [&rest args]¶
Document symbol as function or macro with the given arglist, for example:
(defun hello (name &optional greeting) (message "%s %s" (or greeting "Hello") name))
.. el:function:: hello name &optional greeting Greet the user with the given ``name``. If ``greeting`` is given, use it as greeting, instead of the standard “Hello”.
Documenting interactive commands¶
- .. el:command:: symbol¶
Document symbol as interactive command:
(defun greet (name) (interactive "%M") (message "Hello %s" name))
.. el:command:: greet :binding: C-c g Prompt for a name and greet the user.
Commands are described as a user would type them in Emacs, via M-x, and optionally by specific bindings. Hence, the above example would look like this:
- C-c g
- M-x greet
Prompt for a name and greet the user.
prefix-arg adds the given prefix argument to the keybindings:
.. el:command:: greet :binding: C-c g :prefix-arg: C-u Greet the current user.
- C-u C-c g
- C-u M-x greet
Greet the current user.
Reference an Emacs Lisp command.
Since commands are just functions, this directive is the same as el:function.
Documenting different invocations of a command¶
Emacs Lisp commands can be invoked in different ways, e.g. with or without prefix arguments, with different prefix arguments, or as ordinary function from Emacs Lisp.
This extension encourages you to document all variants of a command independently:
.. el:command:: greet :binding: C-c g Prompt for a name and greet the user. .. el:command:: greet :binding: C-c g :prefix-arg: C-u :noindex: .. el:function:: greet name :noindex: Show a greeting message for the user with the given ``name``.
This example documents three different variants of the Emacs Lisp command greet: Without prefix argument, with universal prefix argument, and as Emacs Lisp function.
To avoid ambiguities in the index and when resolving cross-references, you must add the noindex option to all but the most “important” variant of the command.
In the above example, we presume that C-c g is the most important variant, so we add :noindex: to all others. The index entry and cross-references with thus point to the C-c g variant.
Documenting constants, variables, user options and hooks¶
- .. el:constant:: symbol¶
- .. el:variable:: symbol¶
- .. el:option:: symbol¶
- .. el:hook:: symbol¶
Document symbol as (constant) Emacs Lisp variable, for example:
(defvar python-check-command "pylint")
.. el:variable:: python-check-command :local: :safe: stringp The shell command to use for checking the current buffer.
This documents python-check-command as buffer-local variable which is safe as local variable when its value matches the predicate stringp.
The flag :local: denotes that the variable is automatically buffer-local.
The option :safe: denotes that the variable is safe as local variable with the given predicate. If the predicate is a symbol, its function definition is cross-referenced.
The flag :risky: denotes that the variable is risky to use as local variable.
With el:option or el:hook, document symbol as customizable user option or hook respectively. This does not affect cross-referencing, but uses a different description text for symbol.
- .. el:face:: symbol¶
Document symbol as a face, for example:
(defface error '((t :foreground red)))
.. el:face:: error The face for errors.
Insert a reference to a face.
Documenting CL structs¶
- .. el:cl-struct:: symbol¶
Document symbol as Cl struct defined by cl-defstruct:
(cl-defstruct (person (:constructor person-new) (:constructor person-with-name name)) name mobile)
.. el:cl-struct:: person A person. .. el:cl-slot:: name The name of a person .. el:cl-slot:: mobile The mobile phone number .. el:defun:: person-new :name name :mobile mobile Create a new person with the given ``name`` and ``mobile`` phone number. .. el:defun:: person-with-name name Create a new person with the given ``name``.
- .. el:cl-slot:: slot¶
Documents slot as a slot of the current Cl struct.
Using this directive outside of a el:cl-struct block is an error.
As Cl slots are functions in Emacs Lisp, this directive creates a function reference to the slot. Hence, the name slot from the above example can be referenced either with el:cl-slot or with el:function:
The slot :el:cl-slot:`~person name` holds the name of a person. To get the name, call :el:function:`person-name`.
In this example, both references would point to the description of name as in the example above. The difference is merely in presentation: While el:function always shows the entire function name, role:el:cl-slot only shows the name of the slot, if the reference appears inside a el:cl-struct block, or if the role text starts with a tilde.
Reference a slot of a Cl structure.
The text of the role has the form struct slot where struct is the name of the structure containing the given slot. Inside of a el:cl-struct block, struct may be omitted in which case it defaults to the current structure.
When referencing a slot of the current structure inside a el:cl-struct block, the name of the struct is omitted in the output. To explicitly omit the struct name, prefix the role text with ~, as in :el:cl-slot:`~person name`.