sphinx.jinja2glue.BuiltinTemplateLoader

class documentation

class BuiltinTemplateLoader(TemplateBridge, BaseLoader): (source)

Interfaces the rendering environment of jinja2 for use in Sphinx.

Method	`get_source`	Undocumented
Method	`init`	Called by the builder to initialize the template system.
Method	`newest_template_mtime`	Called by the builder to determine if output files are outdated because of template changes. Return the mtime of the newest template file that was changed. The default implementation returns ``0``.
Method	`render`	Called by the builder to render a template given as a filename with a specified context (a Python dictionary).
Method	`render_string`	Called by the builder to render a template given as a string with a specified context (a Python dictionary).
Instance Variable	`environment`	Undocumented
Instance Variable	`loaders`	Undocumented
Instance Variable	`pathchain`	Undocumented
Instance Variable	`templatepathlen`	Undocumented

def get_source(self, environment, template): (source) ¶

Undocumented

Parameters
environment:`Environment`	Undocumented
template:`str`	Undocumented
Returns
`tuple[str, str, Callable]`	Undocumented

def init(self, builder, theme=None, dirs=None): (source) ¶

overrides sphinx.application.TemplateBridge.init

Called by the builder to initialize the template system. *builder* is the builder object; you'll probably want to look at the value of ``builder.config.templates_path``. *theme* is a :class:`sphinx.theming.Theme` object or None; in the latter case, *dirs* can be list of fixed directories to look for templates.

Parameters
builder:`Builder`	Undocumented
theme:`Theme\|None`	Undocumented
dirs:`list[str]\|None`	Undocumented

def newest_template_mtime(self): (source) ¶

overrides sphinx.application.TemplateBridge.newest_template_mtime

Called by the builder to determine if output files are outdated because of template changes. Return the mtime of the newest template file that was changed. The default implementation returns ``0``.

Returns
`float`	Undocumented

def render(self, template, context): (source) ¶

overrides sphinx.application.TemplateBridge.render

Called by the builder to render a template given as a filename with a specified context (a Python dictionary).

Parameters
template:`str`	Undocumented
context:`dict`	Undocumented
Returns
`str`	Undocumented

def render_string(self, source, context): (source) ¶

overrides sphinx.application.TemplateBridge.render_string

Called by the builder to render a template given as a string with a specified context (a Python dictionary).

Parameters
source:`str`	Undocumented
context:`dict`	Undocumented
Returns
`str`	Undocumented

environment = (source) ¶

Undocumented

loaders = (source) ¶

Undocumented

pathchain = (source) ¶

Undocumented

templatepathlen = (source) ¶

Undocumented