sphinx.util.template.SphinxRenderer

class documentation

class SphinxRenderer(FileRenderer): (source)

Known subclasses: sphinx.builders.gettext.GettextRenderer, sphinx.cmd.quickstart.QuickstartRenderer, sphinx.util.template.LaTeXRenderer, sphinx.util.template.ReSTRenderer

View In Hierarchy

Undocumented

Class Method	`render_from_file`	Undocumented
Method	`__init__`	Undocumented

Inherited from BaseRenderer (via FileRenderer):

Method	`render`	Undocumented
Method	`render_string`	Undocumented
Instance Variable	`env`	Undocumented

@classmethod
def render_from_file(cls, filename, context): (source) ¶

overrides sphinx.util.template.FileRenderer.render_from_file

Undocumented

Parameters
filename:`str`	Undocumented
context:`dict[str, Any]`	Undocumented
Returns
`str`	Undocumented

def __init__(self, template_path=None): (source) ¶

overrides sphinx.util.template.FileRenderer.__init__

overridden in sphinx.builders.gettext.GettextRenderer, sphinx.cmd.quickstart.QuickstartRenderer, sphinx.util.template.LaTeXRenderer, sphinx.util.template.ReSTRenderer

Undocumented

Parameters
template_path:`(None\|str)\|list[str]`	Undocumented