AutomodapiOptions
- class plasmapy_sphinx.autodoc.automodapi.AutomodapiOptions(app: Sphinx, modname: str, options: Dict[str, Any], docname: str = None, _warn: Callable = None)[source]
Bases:
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 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
.A dictionary of options suitable for
automodsumm
based on the options given toautomodapi
, and excluding the group options.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 grouping options.
Additional conditioning of the
:heading-chars:
option.Additional conditioning of the
:include-heading:
option.Additional conditioning of the
:inheritance-diagram:
option.Method for doing any additional conditioning of option arguments.
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
andcustom_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_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 = {'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-index': <function bool_option>, 'no-inheritance-diagram': <function bool_option>, 'no-main-docstring': <function bool_option>, 'no-toctree': <function bool_option>, 'no-value': <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 toautomodapi
, 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 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 grouping options. (See options
automodapi:groups
,automodapi:exclude-groups
, andautomodapi:no-groups
for additional details.)
- condition_heading_chars_option()[source]
Additional conditioning of the
:heading-chars:
option. (See optionautomodapi:heading-chars
for additional details.)
- condition_include_heading_option()[source]
Additional conditioning of the
:include-heading:
option. (See optionautomodapi:include-heading
for additional details.)
- condition_inheritance_diagram_option()[source]
Additional conditioning of the
:inheritance-diagram:
option. (See optionsautomodapi:inheritance-diagram
andautomodapi:no-inheritance-diagram
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
:toctree:
option. (See optionsautomodapi:toctree
andautomodapi: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.