Application¶
- class esbonio.sphinx_agent.app.Esbonio(dbpath, app)[source]¶
Esbonio specific functionality.
- add_directive(name, directive, argument_providers=None)[source]¶
Register a directive with esbonio.
- Parameters:
name (str) – The name of the directive, as the user would type in a document
directive (type[Directive]) – The directive’s implementation
argument_providers (list[types.Directive.ArgumentProvider] | None) – A list of argument providers for the role
- add_role(name, role, target_providers=None)[source]¶
Register a role with esbonio.
- Parameters:
name (str) – The name of the role, as the user would type in a document
role (Any) – The role’s implementation
target_providers (list[types.Role.TargetProvider] | None) – A list of target providers for the role
- static create_directive_argument_provider(name, **kwargs)[source]¶
Create a new directive argument provider
- Parameters:
name (str) – The name of the provider
kwargs – Additional arguments to pass to the provider instance
- Returns:
The target provider
- Return type: