Functions

List of functions in the ude.renderers namespace.

Entity Name	Description
register_renderer	Registers a renderer class under key.
get_renderer_class	Resolves a format spec string to its registered renderer class.
registered_formats

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

get_renderer_class function

Resolves a format spec string to its registered renderer class.

Raises: UdeException: If fmt is not a registered key.

Returns:

The registered BaseRenderer subclass.

Methods

get_renderer_class

get_renderer_class(fmt: str) -> Type[BaseRenderer]

Resolves a format spec string to its registered renderer class.

Raises: UdeException: If fmt is not a registered key.

Returns:

The registered BaseRenderer subclass.

Parameter	Type	Description
fmt	`str`	The format token (e.g. “html”, “hugo_markdown”).

Generated with Flude

register_renderer function

Registers a renderer class under key.

Called by build-time plugin composition (REQ-V3-37) to add plugin-supplied renderers – e.g. flude-oda-plugin’s oda_html/ oda_hugo_markdown – without this module knowing about them.

Methods

register_renderer

register_renderer(key: str, cls: Type)

Registers a renderer class under key.

Called by build-time plugin composition (REQ-V3-37) to add plugin-supplied renderers – e.g. flude-oda-plugin’s oda_html/ oda_hugo_markdown – without this module knowing about them.

Parameter	Type	Description
key	`str`	The `--format`/`renderer.type` spec string this renderer will
cls	`Type`	The `BaseRenderer` subclass to register.

Generated with Flude

registered_formats function

Returns every registered format key, sorted – the single source --format CLI choices and --help output are drawn from (REQ-V3-36/ENG-02).

Methods

registered_formats

registered_formats() -> list

Returns every registered format key, sorted – the single source --format CLI choices and --help output are drawn from (REQ-V3-36/ENG-02).

Generated with Flude