AutomodsummOptions

class plasmapy_sphinx.automodsumm.core.AutomodsummOptions(app: Sphinx, modname: str, options: Dict[str, Any], docname: str = None, _warn: Callable = None)

Bases: object

Class for advanced conditioning and manipulation of option arguments for plasmapy_sphinx.automodsumm.core.Automodsumm.

Parameters:

• app (Sphinx) – Instance of the sphinx application.

• modname (str) – Name of the module given in the automodsumm directive. This is the module to be inspected and have its objects grouped.

• options (Dict[str, Any]) – Dictionary of options given for the automodsumm directive declaration.

• docname (str) – Name of the document/file where the automodsumm direction was declared.

Attributes Summary

app	Instance of the sphinx application.
custom_grouping_info	Dictionary of the custom group info.
default_grouping_info	Dictionary of the default group information.
docname	Name of the document where automodsumm was declared.
grouping_info	The combined grouping info of default_grouping_info and custom_grouping_info
groupings	Set of all the grouping names.
logger	Instance of the SphinxLoggerAdapter for report during builds.
mod_objs	Dictionary of the grouped objects found in the module named by modname.
mod_objs_option_filtered	A filtered version of mod_objs according to the specifications given in options (i.e. those given to automodsumm).
modname	Name of the module given to automodsumm.
option_spec	Mapping of option names to validator functions.
options	Copy of the options given to automodsumm.
pkg_or_module	Is module specified by modname a package or module (i.e. py file).
warn	Instance of a sphinx.util.logging.SphinxLoggerAdapter.warning for reporting warning level messages during a build.

Methods Summary

condition_group_options()	Additional conditioning of the option arguments groups and exclude-groups.
condition_options()	Method for doing any additional conditioning of option arguments.
condition_toctree_option()	Additional conditioning of the option argument toctree.
generate_obj_list([exclude_modules])	Take mod_objs_option_filtered and generated a list of the fully qualified object names.

Attributes Documentation

app

Instance of the sphinx application.

custom_grouping_info

Dictionary of the custom group info.

See also

plasmapy_sphinx.utils.get_custom_grouping_info

default_grouping_info

Dictionary of the default group information.

See also

plasmapy_sphinx.utils.default_grouping_info

docname

Name of the document where automodsumm was declared.

grouping_info

The combined grouping info of default_grouping_info and custom_grouping_info

groupings

Set of all the grouping names.

logger = <SphinxLoggerAdapter sphinx.plasmapy_sphinx.automodsumm.core (DEBUG)>

Instance of the SphinxLoggerAdapter for report during builds.

mod_objs

Dictionary of the grouped objects found in the module named by modname.

See also

plasmapy_sphinx.utils.find_mod_objs

mod_objs_option_filtered

A filtered version of mod_objs according to the specifications given in options (i.e. those given to automodsumm).

modname

Name of the module given to automodsumm.

option_spec = {'caption': <function unchanged_required>, 'exclude-groups': <function option_str_list>, 'groups': <function option_str_list>, 'nosignatures': <function flag>, 'recursive': <function flag>, 'skip': <function option_str_list>, 'template': <function unchanged>, 'toctree': <function unchanged>}

Mapping of option names to validator functions. (see docutils.parsers.rst.Directive.option_spec)

options

Copy of the options given to automodsumm.

pkg_or_module

Is module specified by modname a package or module (i.e. py file). Return "pkg" for a package and "module" for a py file.

warn

Instance of a sphinx.util.logging.SphinxLoggerAdapter.warning for reporting warning level messages during a build.

Methods Documentation

condition_group_options()

Additional conditioning of the option arguments groups and exclude-groups. (See automodsumm:groups and automodsumm:exclude-groups for additional details.)

condition_options()

Method for doing any additional conditioning of option arguments. Called during class instantiation.

condition_toctree_option()

Additional conditioning of the option argument toctree. (See automodsumm:toctree for additional details.)

generate_obj_list(exclude_modules: bool = False) → List[str]

Take mod_objs_option_filtered and generated a list of the fully qualified object names. The list is sorted based on the casefolded short names of the objects.

Parameters:

exclude_modules (bool) – (Default False) Set True to exclude the qualified names related to objects sorted in the modules group.