plasmapy_sphinx.ext.directives
This module is a Sphinx extension
that exposes the functionality of plasmapy_sphinx.directives.
plasmapy_sphinx.directives defines
directives
and
roles
that do not fall under the scopes of autodoc or
automodsumm. If a directive that has an associated role,
then that role is used for cross-referencing the declared item. For example,
:meth:`Foo.bar` is a cross-referencing role to link back to where
.. automethod:: Foo.bar was declared.
Directive |
Role |
Description |
|---|---|---|
.. confval:: name |
:confval:`name` |
For declaring and referencing Sphinx configuration values. |
.. event:: name |
:event:`name` |
For declaring and referencing Sphinx events. |
Functions
|
A |