plasmapy_sphinx.directives

This sub-package 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 .. confval:: name	confval :confval:`name`	For declaring and referencing Sphinx configuration values.
event .. event:: name	event :event:`name`	For declaring and referencing Sphinx events.

API

Subpackages & Modules

confval	Functionality for declaring and cross-referencing Sphinx configuration values.
event	Functionality for declaring and cross-referencing Sphinx events.

Functions

setup(app)

A sphinx setup() function for setting up all the functionality defined in plasmapy_sphinx.directives.