plasmapy_sphinx.automodsumm

This sub-package contains functionality that defines the automodsumm directive and the stub file generation for items listed in automodsumm tables.

This functionality was highly influenced by and adapted from sphinx.ext.autosummary and sphinx_automodapi.automodsumm.

Defined Directives

A directive (ref) is a generic block of explicit markup. Along with roles, it is one of the extension mechanisms of reST and, thus, Sphinx.

Directive	Description
automodsumm .. automodsumm:: modname	A directive that generates and auto-populates autosummary tables for a given module modname (i.e. sub-package or .py file).

Defined Configuration Values

Configuration values are variables that can be defined in the conf.py file to control the default behavior Sphinx and Sphinx extension packages like plasmapy_sphinx.

Configuration Value	Description
automodapi_custom_groups	Used to define custom groups to be displayed by the automodsumm and automodapi directives
automodapi_generate_module_stub_files	Used to control is stub files are by default generated to modules (i.e. sub-packages and .py files).

Connected Sphinx Events

Sphinx events occur at specific points in the Sphinx build that “pauses” the build process, signals connected functionality to do additional processing, and then continues with the processed results.

Event	Connected
builder-inited	GenDocsFromAutomodsumm
autodoc-skip-member	event_handler__autodoc_skip_member

API

Subpackages & Modules

core	This module contains the functionality used to define the automodsumm directive and its supporting configuration values.
generate	This module contains functionality for auto-generating the stub files related to the automodapi and automodsumm directives.

Functions

setup(app)

Sphinx setup() function for setting up the automodsumm functionality.