AutomodapiOptions

class plasmapy_sphinx.autodoc.automodapi.AutomodapiOptions(app: Sphinx, modname: str, options: Dict[str, Any], docname: str = None, _warn: Callable = None)

Bases: plasmapy_sphinx.automodsumm.core.AutomodsummOptions

Class for advanced conditioning and manipulation of option arguments of plasmapy_sphinx.autodoc.automodapi.ModAPIDocumenter.

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 it’s 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.

  • _warn (Callable) – Instance of a sphinx.util.logging.SphinxLoggerAdapter.warning for reporting warning level messages during a build.

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.

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.

options_for_automodsumm

A dictionary of options suitable for automodsumm based on the options given to automodapi, and excluding the group options.

pkg_or_module

Is module specified by modname a package or module (i.e.

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 grouping options.

condition_heading_chars_option()

Additional conditioning of the :heading-chars: option.

condition_include_heading_option()

Additional conditioning of the :include-heading: option.

condition_inheritance_diagram_option()

Additional conditioning of the :inheritance-diagram: option.

condition_options()

Method for doing any additional conditioning of option arguments.

condition_toctree_option()

Additional conditioning of the :toctree: option.

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.

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 = <SphinxLoggerAdapter sphinx.plasmapy_sphinx.autodoc.automodapi (DEBUG)>

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 = {'deprecated': <function bool_option>, 'exclude-groups': <function option_str_list>, 'groups': <function option_str_list>, 'heading-chars': <function unchanged>, 'include-heading': <function bool_option>, 'inheritance-diagram': <function bool_option>, 'no-groups': <function bool_option>, 'no-inheritance-diagram': <function bool_option>, 'no-main-docstring': <function bool_option>, 'no-toctree': <function bool_option>, 'noindex': <function bool_option>, 'platform': <function identity>, 'show-inheritance': <function bool_option>, 'skip': <function option_str_list>, 'synopsis': <function identity>, '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.

options_for_automodsumm

A dictionary of options suitable for automodsumm based on the options given to automodapi, and excluding the group options.

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 grouping options. (See options automodapi:groups, automodapi:exclude-groups, and automodapi:no-groups for additional details.)

condition_heading_chars_option()

Additional conditioning of the :heading-chars: option. (See option automodapi:heading-chars for additional details.)

condition_include_heading_option()

Additional conditioning of the :include-heading: option. (See option automodapi:include-heading for additional details.)

condition_inheritance_diagram_option()

Additional conditioning of the :inheritance-diagram: option. (See options automodapi:inheritance-diagram and automodapi:no-inheritance-diagram 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 :toctree: option. (See options automodapi:toctree and automodapi:no-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.