sphinx.registry.SphinxComponentRegistry

class documentation

class SphinxComponentRegistry:

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_source_input`	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	`source_inputs`	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):

Undocumented

def add_autodoc_attrgetter(self, typ, attrgetter):

Undocumented

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

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

Undocumented

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

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

Undocumented

Parameters
directivename:`str`	Undocumented
rolename:`str`	Undocumented
indextemplate:`str`	Undocumented
ref_nodeclass:`Type[TextElement]`	Undocumented
objname:`str`	Undocumented
override:`bool`	Undocumented

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

Undocumented

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

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

Undocumented

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

def add_documenter(self, objtype, documenter):

Undocumented

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

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

Undocumented

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

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

Undocumented

Parameters
node:`Type[Node]`	Undocumented
figtype:`str`	Undocumented
title_getter:`TitleGetter`	Undocumented
override:`bool`	Undocumented

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

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):

Undocumented

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

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

Undocumented

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

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

Undocumented

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

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

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):

Undocumented

Parameters
directivename:`str`	Undocumented
rolename:`str`	Undocumented
indextemplate:`str`	Undocumented
parse_node:`Callable`	Undocumented
ref_nodeclass:`Type[TextElement]`	Undocumented
objname:`str`	Undocumented
doc_field_types:`List`	Undocumented
override:`bool`	Undocumented

def add_post_transform(self, transform):

Undocumented

Parameters
transform:`Type[Transform]`	Undocumented

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

Undocumented

Parameters
domain:`str`	Undocumented
name:`str`	Undocumented
role:`Union[RoleFunction, XRefRole]`	Undocumented
override:`bool`	Undocumented

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

Undocumented

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

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

Undocumented

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

def add_transform(self, transform):

Undocumented

Parameters
transform:`Type[Transform]`	Undocumented

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

Undocumented

Parameters
node:`Type[Element]`	Undocumented
**kwargs:`Tuple[Callable, Callable]`	Undocumented

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

Undocumented

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

def create_builder(self, app, name):

Undocumented

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

def create_domains(self, env):

Undocumented

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

def create_source_parser(self, app, filename):

Undocumented

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

def create_translator(self, builder, *args):

Undocumented

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

def get_envversion(self, app):

Undocumented

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

def get_post_transforms(self):

Undocumented

Returns
`List[Type[Transform]]`	Undocumented

def get_source_input(self, filetype):

Undocumented

Parameters
filetype:`str`	Undocumented
Returns
`Optional[Type[Input]]`	Undocumented

def get_source_parser(self, filetype):

Undocumented

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

def get_source_parsers(self):

Undocumented

Returns
`Dict[str, Type[Parser]]`	Undocumented

def get_transforms(self):

Undocumented

Returns
`List[Type[Transform]]`	Undocumented

def get_translator_class(self, builder):

Undocumented

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

def has_domain(self, domain):

Undocumented

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

def has_latex_package(self, name):

Undocumented

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

def load_extension(self, app, extname):

Load a Sphinx extension.

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

def preload_builder(self, app, name):

Undocumented

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

autodoc_attrgettrs: Dict[Type, Callable[[Any, str, Any], Any]] =

Undocumented

builders: Dict[str, Type[Builder]] =

Undocumented

css_files: List[Tuple[str, Dict[str, Any]]] =

Undocumented

documenters: Dict[str, Type[Documenter]] =

Undocumented

domain_directives: Dict[str, Dict[str, Any]] =

Undocumented

domain_indices: Dict[str, List[Type[Index]]] =

Undocumented

domain_object_types: Dict[str, Dict[str, ObjType]] =

Undocumented

domain_roles: Dict[str, Dict[str, Union[RoleFunction, XRefRole]]] =

Undocumented

domains: Dict[str, Type[Domain]] =

Undocumented

enumerable_nodes: Dict[Type[Node], Tuple[str, TitleGetter]] =

Undocumented

html_assets_policy: str =

Undocumented

html_block_math_renderers: Dict[str, Tuple[Callable, Callable]] =

Undocumented

html_inline_math_renderers: Dict[str, Tuple[Callable, Callable]] =

Undocumented

html_themes: Dict[str, str] =

Undocumented

js_files: List[Tuple[str, Dict[str, Any]]] =

Undocumented

latex_packages: List[Tuple[str, str]] =

Undocumented

latex_packages_after_hyperref: List[Tuple[str, str]] =

Undocumented

post_transforms: List[Type[Transform]] =

Undocumented

source_inputs: Dict[str, Type[Input]] =

Undocumented

source_parsers: Dict[str, Type[Parser]] =

Undocumented

source_suffix: Dict[str, str] =

Undocumented

transforms: List[Type[Transform]] =

Undocumented

translation_handlers: Dict[str, Dict[str, Tuple[Callable, Callable]]] =

Undocumented

translators: Dict[str, Type[nodes.NodeVisitor]] =

Undocumented