plasmapy_sphinx.utils

A utility package containing functions and variables to support development of the core functionality in plasmapy_sphinx.

Functions

find_mod_objs(modname[, app])

Inspect the module modname for all the contained objects, sort for the object type (module, function, class, etc.), and return a dictionary containing object names, fully qualified names, and instances.

get_custom_grouping_info(app)

Retrieve the custom groups dictionary defined by the configuration value automodapi_custom_groups.

Variables & Attributes

default_grouping_info

Dictionary containing information related to the default object groups used by the automodapi and automodsumm directives.

package_dir

Absolute path to the plasmapy_sphinx package directory.

templates_dir

Absolute path to the plasmapy_sphinx templates directory.