Markdown не работает с django-rest-framework

Question

В настоящее время я создаю API, используя django-rest-framework.

Образцы (например, http://restframework.herokuapp.com/) имеют поддержку документирования Markdown.

Как активировать это в моем собственном проекте? Это не работает из коробки, и я не могу найти помощь для этого на веб-сайте (в документации по учебнику). Я уже установил markdown с пипсом (v2.1.1).

Спасибо,

Answer 1

Хм, чувствую себя глупо.

Мой код был:

class UserList(ListCreateAPIView): 
    """ 
    Display all `users`. 
    """ 

Рабочий код должен быть:

class UserList(ListCreateAPIView): 
    """ 
Display all `users`. 
    """ 

(строка уценки не должна быть отступом)

Answer 2

Все, что вам нужно сделать, это установить markdown, а затем записать уценки отформатированы строки документации.

Если он не работает, возможно, вы захотите дважды проверить, что вы установили уценку в проект virtualenv, а не глобально.