DoxySummaryRenderer

class sphinx_doxysummary.generate.DoxySummaryRenderer(app: Sphinx)

Renderer generating rst files based on templates.

env

Enviroment containing path to possible templates to match.

Type:

jinja2.sandbox.SandboxedEnvironment

__init__(app: Sphinx) → None

Parameters:

app (Sphinx) – Sphinx application.

Raises:

ValueError – When app is not a sphinx.Builder.

render(template_name: str, context: Dict[str, Any]) → str

Render a string based on a template.

The renderer will first find template in source directory, then in the template path declared in conf.py, and finally in the template directory of this package.

Parameters:

• template_name (str) – File name of the template.

• context (Dict[str, Any]) – Python dict of keyword-value to be fetched in the template.

Returns:

Content of the template with matched keywords.

Return type:

str