AutomodsummOptions
- class plasmapy_sphinx.automodsumm.core.AutomodsummOptions(app: Sphinx, modname: str, options: Dict[str, Any], docname: str = None, _warn: Callable = None)[source]
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 theautomodsumm
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
Instance of the sphinx application.
Dictionary of the custom group info.
Dictionary of the default group information.
Name of the document where
automodsumm
was declared.The combined grouping info of
default_grouping_info
andcustom_grouping_info
Set of all the grouping names.
Instance of the
SphinxLoggerAdapter
for report during builds.Dictionary of the grouped objects found in the module named by
modname
.A filtered version of
mod_objs
according to the specifications given inoptions
(i.e. those given toautomodsumm
).Name of the module given to
automodsumm
.Mapping of option names to validator functions.
Copy of the options given to
automodsumm
.Is module specified by
modname
a package or module (i.e.py
file).Instance of a
sphinx.util.logging.SphinxLoggerAdapter.warning
for reporting warning level messages during a build.Methods Summary
Additional conditioning of the option arguments
groups
andexclude-groups
.Method for doing any additional conditioning of option arguments.
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.
- 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
andcustom_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_option_filtered
A filtered version of
mod_objs
according to the specifications given inoptions
(i.e. those given toautomodsumm
).
- 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 apy
file.
- warn
Instance of a
sphinx.util.logging.SphinxLoggerAdapter.warning
for reporting warning level messages during a build.
Methods Documentation
- condition_group_options()[source]
Additional conditioning of the option arguments
groups
andexclude-groups
. (Seeautomodsumm:groups
andautomodsumm:exclude-groups
for additional details.)
- condition_options()[source]
Method for doing any additional conditioning of option arguments. Called during class instantiation.
- condition_toctree_option()[source]
Additional conditioning of the option argument
toctree
. (Seeautomodsumm:toctree
for additional details.)