class documentation
class TemplateBridge: (source)
Known subclasses: sphinx.jinja2glue.BuiltinTemplateLoader
This class defines the interface for a "template bridge", that is, a class that renders templates given a template name and a context.
| Method | init |
Called by the builder to initialize the template system. |
| Method | newest |
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 |
Called by the builder to render a template given as a string with a specified context (a Python dictionary). |
overridden in
sphinx.jinja2glue.BuiltinTemplateLoaderCalled 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[ | Undocumented |
overridden in
sphinx.jinja2glue.BuiltinTemplateLoaderCalled 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 |