Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit ff56db4

Browse files
author
Rachel Hutchison
committed
Add optional markdown
1 parent 4cb10da commit ff56db4

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

‎rest_framework_docs/templates/rest_framework_docs/home.html

Lines changed: 2 additions & 1 deletion
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 %}

‎rest_framework_docs/templatetags/__init__.py

Whitespace-only changes.
Lines changed: 12 additions & 0 deletions
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)

AltStyle によって変換されたページ (->オリジナル) /