template

Django template engine for Docutils.

class django_docutils.template.DocutilsTemplates
class[source]
class[source]
class django_docutils.template.DocutilsTemplates

Bases: BaseEngine

Docutils engine for Django.

app_dirname: str = 'templates'
attribute
attribute
app_dirname: str = 'templates'
__init__(params)
method[source]
method[source]
__init__(params)

Initialize the template engine.

params is a dict of configuration settings.

Parameters:

params (dict[str, Any])

Return type:

None

from_string(template_code)
method[source]
method[source]
from_string(template_code)

Return DocutilsTemplate from string.

Parameters:

template_code (str)

Return type:

DocutilsTemplate

get_template(template_name)
method[source]
method[source]
get_template(template_name)

Return template from template_name.

Parameters:

template_name (str)

Return type:

DocutilsTemplate

class django_docutils.template.DocutilsTemplate
class[source]
class[source]
class django_docutils.template.DocutilsTemplate

Bases: object

Docutils template object for Django. Used by Docutils template engine.

__init__(source, options)
method[source]
method[source]
__init__(source, options)
Parameters:
Return type:

None

render(context=None, request=None)
method[source]
method[source]
render(context=None, request=None)

Render DocutilsTemplate to string.

Examples

>>> template = DocutilsTemplate("Hello **world**", {})
>>> "world" in template.render()
True
Parameters:
Return type:

SafeString