sphinx.registry.SphinxComponentRegistry

class documentation

class SphinxComponentRegistry: (source)

Undocumented

Method	`__init__`	Undocumented
Method	`add_autodoc_attrgetter`	Undocumented
Method	`add_builder`	Undocumented
Method	`add_crossref_type`	Undocumented
Method	`add_css_files`	Undocumented
Method	`add_directive_to_domain`	Undocumented
Method	`add_documenter`	Undocumented
Method	`add_domain`	Undocumented
Method	`add_enumerable_node`	Undocumented
Method	`add_html_math_renderer`	Undocumented
Method	`add_html_theme`	Undocumented
Method	`add_index_to_domain`	Undocumented
Method	`add_js_file`	Undocumented
Method	`add_latex_package`	Undocumented
Method	`add_object_type`	Undocumented
Method	`add_post_transform`	Undocumented
Method	`add_role_to_domain`	Undocumented
Method	`add_source_parser`	Undocumented
Method	`add_source_suffix`	Undocumented
Method	`add_transform`	Undocumented
Method	`add_translation_handlers`	Undocumented
Method	`add_translator`	Undocumented
Method	`create_builder`	Undocumented
Method	`create_domains`	Undocumented
Method	`create_source_parser`	Undocumented
Method	`create_translator`	Undocumented
Method	`get_envversion`	Undocumented
Method	`get_post_transforms`	Undocumented
Method	`get_publisher`	Undocumented
Method	`get_source_parser`	Undocumented
Method	`get_source_parsers`	Undocumented
Method	`get_transforms`	Undocumented
Method	`get_translator_class`	Undocumented
Method	`has_domain`	Undocumented
Method	`has_latex_package`	Undocumented
Method	`load_extension`	Load a Sphinx extension.
Method	`preload_builder`	Undocumented
Instance Variable	`autodoc_attrgettrs`	Undocumented
Instance Variable	`builders`	Undocumented
Instance Variable	`css_files`	Undocumented
Instance Variable	`documenters`	Undocumented
Instance Variable	`domain_directives`	Undocumented
Instance Variable	`domain_indices`	Undocumented
Instance Variable	`domain_object_types`	Undocumented
Instance Variable	`domain_roles`	Undocumented
Instance Variable	`domains`	Undocumented
Instance Variable	`enumerable_nodes`	Undocumented
Instance Variable	`html_assets_policy`	Undocumented
Instance Variable	`html_block_math_renderers`	Undocumented
Instance Variable	`html_inline_math_renderers`	Undocumented
Instance Variable	`html_themes`	Undocumented
Instance Variable	`js_files`	Undocumented
Instance Variable	`latex_packages`	Undocumented
Instance Variable	`latex_packages_after_hyperref`	Undocumented
Instance Variable	`post_transforms`	Undocumented
Instance Variable	`publishers`	Undocumented
Instance Variable	`source_parsers`	Undocumented
Instance Variable	`source_suffix`	Undocumented
Instance Variable	`transforms`	Undocumented
Instance Variable	`translation_handlers`	Undocumented
Instance Variable	`translators`	Undocumented

def __init__(self): (source) ¶

Undocumented

def add_autodoc_attrgetter(self, typ, attrgetter): (source) ¶

Undocumented

Parameters
typ:`type`	Undocumented
attrgetter:`Callable[[Any, str, Any], Any]`	Undocumented

def add_builder(self, builder, override=False): (source) ¶

Undocumented

Parameters
builder:`type[Builder]`	Undocumented
override:`bool`	Undocumented

def add_crossref_type(self, directivename, rolename, indextemplate='', ref_nodeclass=None, objname='', override=False): (source) ¶

Undocumented

Parameters
directivename:`str`	Undocumented
rolename:`str`	Undocumented
indextemplate:`str`	Undocumented
ref_nodeclass:`type[TextElement]\|None`	Undocumented
objname:`str`	Undocumented
override:`bool`	Undocumented

def add_css_files(self, filename, **attributes): (source) ¶

Undocumented

Parameters
filename:`str`	Undocumented
**attributes:`Any`	Undocumented

def add_directive_to_domain(self, domain, name, cls, override=False): (source) ¶

Undocumented

Parameters
domain:`str`	Undocumented
name:`str`	Undocumented
cls:`type[Directive]`	Undocumented
override:`bool`	Undocumented

def add_documenter(self, objtype, documenter): (source) ¶

Undocumented

Parameters
objtype:`str`	Undocumented
documenter:`type[Documenter]`	Undocumented

def add_domain(self, domain, override=False): (source) ¶

Undocumented

Parameters
domain:`type[Domain]`	Undocumented
override:`bool`	Undocumented

def add_enumerable_node(self, node, figtype, title_getter=None, override=False): (source) ¶

Undocumented

Parameters
node:`type[Node]`	Undocumented
figtype:`str`	Undocumented
title_getter:`TitleGetter\|None`	Undocumented
override:`bool`	Undocumented

def add_html_math_renderer(self, name, inline_renderers, block_renderers): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
inline_renderers:`tuple[Callable, Callable]`	Undocumented
block_renderers:`tuple[Callable, Callable]`	Undocumented

def add_html_theme(self, name, theme_path): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
theme_path:`str`	Undocumented

def add_index_to_domain(self, domain, index, override=False): (source) ¶

Undocumented

Parameters
domain:`str`	Undocumented
index:`type[Index]`	Undocumented
override:`bool`	Undocumented

def add_js_file(self, filename, **attributes): (source) ¶

Undocumented

Parameters
filename:`str`	Undocumented
**attributes:`Any`	Undocumented

def add_latex_package(self, name, options, after_hyperref=False): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
options:`str`	Undocumented
after_hyperref:`bool`	Undocumented

def add_object_type(self, directivename, rolename, indextemplate='', parse_node=None, ref_nodeclass=None, objname='', doc_field_types=[], override=False): (source) ¶

Undocumented

Parameters
directivename:`str`	Undocumented
rolename:`str`	Undocumented
indextemplate:`str`	Undocumented
parse_node:`Callable\|None`	Undocumented
ref_nodeclass:`type[TextElement]\|None`	Undocumented
objname:`str`	Undocumented
doc_field_types:`list`	Undocumented
override:`bool`	Undocumented

def add_post_transform(self, transform): (source) ¶

Undocumented

Parameters
transform:`type[Transform]`	Undocumented

def add_role_to_domain(self, domain, name, role, override=False): (source) ¶

Undocumented

Parameters
domain:`str`	Undocumented
name:`str`	Undocumented
role:`RoleFunction\|XRefRole`	Undocumented
override:`bool`	Undocumented

def add_source_parser(self, parser, override=False): (source) ¶

Undocumented

Parameters
parser:`type[Parser]`	Undocumented
override:`bool`	Undocumented

def add_source_suffix(self, suffix, filetype, override=False): (source) ¶

Undocumented

Parameters
suffix:`str`	Undocumented
filetype:`str`	Undocumented
override:`bool`	Undocumented

def add_transform(self, transform): (source) ¶

Undocumented

Parameters
transform:`type[Transform]`	Undocumented

def add_translation_handlers(self, node, **kwargs): (source) ¶

Undocumented

Parameters
node:`type[Element]`	Undocumented
**kwargs:`tuple[Callable, Callable]`	Undocumented

def add_translator(self, name, translator, override=False): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
translator:`type[nodes.NodeVisitor]`	Undocumented
override:`bool`	Undocumented

def create_builder(self, app, name, env=None): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
name:`str`	Undocumented
env:`BuildEnvironment\|None`	Undocumented
Returns
`Builder`	Undocumented

def create_domains(self, env): (source) ¶

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
Returns
`Iterator[Domain]`	Undocumented

def create_source_parser(self, app, filename): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
filename:`str`	Undocumented
Returns
`Parser`	Undocumented

def create_translator(self, builder, *args): (source) ¶

Undocumented

Parameters
builder:`Builder`	Undocumented
*args:`Any`	Undocumented
Returns
`nodes.NodeVisitor`	Undocumented

def get_envversion(self, app): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
Returns
`dict[str, str]`	Undocumented

def get_post_transforms(self): (source) ¶

Undocumented

Returns
`list[type[Transform]]`	Undocumented

def get_publisher(self, app, filetype): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
filetype:`str`	Undocumented
Returns
`Publisher`	Undocumented

def get_source_parser(self, filetype): (source) ¶

Undocumented

Parameters
filetype:`str`	Undocumented
Returns
`type[Parser]`	Undocumented

def get_source_parsers(self): (source) ¶

Undocumented

Returns
`dict[str, type[Parser]]`	Undocumented

def get_transforms(self): (source) ¶

Undocumented

Returns
`list[type[Transform]]`	Undocumented

def get_translator_class(self, builder): (source) ¶

Undocumented

Parameters
builder:`Builder`	Undocumented
Returns
`type[nodes.NodeVisitor]`	Undocumented

def has_domain(self, domain): (source) ¶

Undocumented

Parameters
domain:`str`	Undocumented
Returns
`bool`	Undocumented

def has_latex_package(self, name): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
Returns
`bool`	Undocumented

def load_extension(self, app, extname): (source) ¶

Load a Sphinx extension.

Parameters
app:`Sphinx`	Undocumented
extname:`str`	Undocumented

def preload_builder(self, app, name): (source) ¶

Undocumented

Parameters
app:`Sphinx`	Undocumented
name:`str`	Undocumented

autodoc_attrgettrs: dict[type, Callable[[Any, str, Any], Any]] = (source) ¶

Undocumented

builders: dict[str, type[Builder]] = (source) ¶

Undocumented

css_files: list[tuple[str, dict[str, Any]]] = (source) ¶

Undocumented

documenters: dict[str, type[Documenter]] = (source) ¶

Undocumented

domain_directives: dict[str, dict[str, type[Directive]]] = (source) ¶

Undocumented

domain_indices: dict[str, list[type[Index]]] = (source) ¶

Undocumented

domain_object_types: dict[str, dict[str, ObjType]] = (source) ¶

Undocumented

domain_roles: dict[str, dict[str, RoleFunction|XRefRole]] = (source) ¶

Undocumented

domains: dict[str, type[Domain]] = (source) ¶

Undocumented

enumerable_nodes: dict[type[Node], tuple[str, TitleGetter]] = (source) ¶

Undocumented

html_assets_policy: str = (source) ¶

Undocumented

html_block_math_renderers: dict[str, tuple[Callable, Callable]] = (source) ¶

Undocumented

html_inline_math_renderers: dict[str, tuple[Callable, Callable]] = (source) ¶

Undocumented

html_themes: dict[str, str] = (source) ¶

Undocumented

js_files: list[tuple[str, dict[str, Any]]] = (source) ¶

Undocumented

latex_packages: list[tuple[str, str]] = (source) ¶

Undocumented

latex_packages_after_hyperref: list[tuple[str, str]] = (source) ¶

Undocumented

post_transforms: list[type[Transform]] = (source) ¶

Undocumented

publishers: dict[str, Publisher] = (source) ¶

Undocumented

source_parsers: dict[str, type[Parser]] = (source) ¶

Undocumented

source_suffix: dict[str, str] = (source) ¶

Undocumented

transforms: list[type[Transform]] = (source) ¶

Undocumented

translation_handlers: dict[str, dict[str, tuple[Callable, Callable]]] = (source) ¶

Undocumented

translators: dict[str, type[nodes.NodeVisitor]] = (source) ¶

Undocumented