docutils (a.k.a. reStructuredText / rst / reST) support for Django.
Install django-docutils:
$ pip install django-docutilsNext, add django_docutils to your INSTALLED_APPS in your settings file:
INSTALLED_APPS = [ # ... your default apps, 'django_docutils' ]In your template:
{% load django_docutils %} {% rst %} # hey # how's it going A. hows B. it C. going D. today **hi** *hi* {% endrst %}In your template:
{% load django_docutils %} {% filter rst %} # hey # how's it going A. hows B. it C. going D. today **hi** *hi* {% endfilter %}You can also use a class-based view to render reStructuredText (reST).
If you want to use reStructuredText as a django template engine, INSTALLED_APPS isn't required, instead you add this to your TEMPLATES variable in your settings:
TEMPLATES = [ # ... Other engines { "NAME": "docutils", "BACKEND": "django_docutils.template.DocutilsTemplates", "DIRS": [], "APP_DIRS": True, } ]Now django will be able to scan for .rst files and process them. In your view:
from django_docutils.views import DocutilsView class HomeView(DocutilsView): template_name = 'base.html' rst_name = 'home.rst'# Optional, automatically maps roles, directives and transformers DJANGO_DOCUTILS_LIB_RST = { "docutils": { "raw_enabled": True, "strip_comments": True, "initial_header_level": 2, }, "roles": { "local": { "gh": "django_docutils.lib.roles.github.github_role", "twitter": "django_docutils.lib.roles.twitter.twitter_role", "email": "django_docutils.lib.roles.email.email_role", } }, "directives": { "code-block": "django_docutils.lib.directives.code.CodeBlock", } } # Optional DJANGO_DOCUTILS_LIB_TEXT = { "uncapitalized_word_filters": ["project.my_module.my_capitalization_fn"] }- Python 3.10+
- Django 4.2+
![@dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?s=64&v=4){kind=small}
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}