From ff56db4af52f8a09eb91ac2e3f90362f3f5e16cb Mon Sep 17 00:00:00 2001 From: Rachel Hutchison Date: Fri, 29 Jul 2016 11:39:44 -0700 Subject: [PATCH] Add optional markdown --- .../templates/rest_framework_docs/home.html | 3 ++- rest_framework_docs/templatetags/__init__.py | 0 rest_framework_docs/templatetags/drfdocs_filters.py | 12 ++++++++++++ 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 rest_framework_docs/templatetags/__init__.py create mode 100644 rest_framework_docs/templatetags/drfdocs_filters.py diff --git a/rest_framework_docs/templates/rest_framework_docs/home.html b/rest_framework_docs/templates/rest_framework_docs/home.html index 235a6ee..e13e5a5 100644 --- a/rest_framework_docs/templates/rest_framework_docs/home.html +++ b/rest_framework_docs/templates/rest_framework_docs/home.html @@ -1,4 +1,5 @@ {% extends "rest_framework_docs/docs.html" %} +{% load drfdocs_filters %} {% block apps_menu %} {% regroup endpoints by name_parent as endpoints_grouped %} @@ -56,7 +57,7 @@

{% if endpoint.docstring %} -

{{ endpoint.docstring }}

+

{{ endpoint.docstring|markdown }}

{% endif %} {% if endpoint.errors %} diff --git a/rest_framework_docs/templatetags/__init__.py b/rest_framework_docs/templatetags/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/rest_framework_docs/templatetags/drfdocs_filters.py b/rest_framework_docs/templatetags/drfdocs_filters.py new file mode 100644 index 0000000..4d1642a --- /dev/null +++ b/rest_framework_docs/templatetags/drfdocs_filters.py @@ -0,0 +1,12 @@ +from django import template +from django.template.defaultfilters import stringfilter +from rest_framework.utils.formatting import markup_description + + +register = template.Library() + + +@register.filter(name='markdown') +@stringfilter +def markdown(value): + return markup_description(value)