class BuiltinTemplateLoader(TemplateBridge, BaseLoader):
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 |
Undocumented
Parameters | |
environment:Environment | Undocumented |
template:str | Undocumented |
Returns | |
Tuple[ | Undocumented |
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 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 | Undocumented |
dirs:List[ | Undocumented |
Returns | |
float | Undocumented |
sphinx.application.TemplateBridge.render
Parameters | |
template:str | Undocumented |
context:Dict | Undocumented |
Returns | |
str | Undocumented |