templatetags.django_docutils

Django template tag and filter for docutils (rendering reStructuredText as HTML).

class django_docutils.templatetags.django_docutils.ReStructuredTextNode

class

Bases: Node

Implement the actions of the rst tag.

__init__(content, args=None, kwargs=None, asvar=None)

method

Parameters:

• content (FilterExpression | str)

• args (list[FilterExpression] | None)

• kwargs (dict[str, FilterExpression] | None)

• asvar (str | None)

Return type:

None

render(context=None)

method

Render Node as string.

Parameters:

context (Context | None)

Return type:

str

exception django_docutils.templatetags.django_docutils.MalformedArgumentsToRSTTag

exception

Bases: TemplateSyntaxError

Invalid arguments to rst django template tag.

__init__(*args, **kwargs)

method

Parameters:

• args (object)

• kwargs (object)

Return type:

None

django_docutils.templatetags.django_docutils.rst(parser, token)

function

Django template tag to render reStructuredText as HTML.

Supports arguments, see below.

Examples

{% rst content %}

{% rst content toc_only=True %}

{% rst content show_title=False %}

{% rst %}
**Hello world**
{% endrst %}

Render table of contents:

{% rst toc_only=True %}
Welcome to my site!
===================

My header
---------

Some text

Additional information
----------------------

Thank you
{% endrst %}

Parameters:

• parser (Parser)

• token (Token)

Return type:

ReStructuredTextNode

django_docutils.templatetags.django_docutils.rst_filter(value)

function

Django template filter to render reStructuredText (rst) as HTML.

Parameters:

value (str)

Return type:

str