sphinx.cmd.quickstart.QuickstartRenderer

class documentation

class QuickstartRenderer(SphinxRenderer): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method render Undocumented
Instance Variable templatedir Undocumented
Method _has_custom_template Check if custom template file exists.

Inherited from SphinxRenderer:

Class Method render_from_file Undocumented

Inherited from BaseRenderer (via SphinxRenderer, FileRenderer):

Method render_string Undocumented
Instance Variable env Undocumented
def __init__(self, templatedir=''): (source)
overrides sphinx.util.template.SphinxRenderer.__init__

Undocumented

Parameters
templatedir:strUndocumented
def render(self, template_name, context): (source)
overrides sphinx.util.template.BaseRenderer.render

Undocumented

Parameters
template_name:strUndocumented
context:dict[str, Any]Undocumented
Returns
strUndocumented
templatedir = (source)

Undocumented

def _has_custom_template(self, template_name): (source)

Check if custom template file exists. Note: Please don't use this function from extensions. It will be removed in the future without deprecation period.

Parameters
template_name:strUndocumented
Returns
boolUndocumented