Skip to content

Commit 00cdf6d

Browse files
committed
Merge remote-tracking branch 'rainyday/markdown'
2 parents 089f754 + ff56db4 commit 00cdf6d

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

Diff for: rest_framework_docs/templates/rest_framework_docs/home.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{% extends "rest_framework_docs/docs.html" %}
2+
{% load drfdocs_filters %}
23

34
{% block apps_menu %}
45
{% regroup endpoints by name_parent as endpoints_grouped %}
@@ -56,7 +57,7 @@ <h4 class="panel-title title">
5657
<div id="{{ endpoint.path|slugify }}" class="panel-collapse collapse" role="tabpanel">
5758
<div class="panel-body">
5859
{% if endpoint.docstring %}
59-
<p class="lead">{{ endpoint.docstring }}</p>
60+
<p class="lead">{{ endpoint.docstring|markdown }}</p>
6061
{% endif %}
6162

6263
{% if endpoint.errors %}

Diff for: rest_framework_docs/templatetags/__init__.py

Whitespace-only changes.

Diff for: rest_framework_docs/templatetags/drfdocs_filters.py

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
from django import template
2+
from django.template.defaultfilters import stringfilter
3+
from rest_framework.utils.formatting import markup_description
4+
5+
6+
register = template.Library()
7+
8+
9+
@register.filter(name='markdown')
10+
@stringfilter
11+
def markdown(value):
12+
return markup_description(value)

0 commit comments

Comments
 (0)