Как форматировать Django views docstring

Question

Я использую простые представления в своем проекте, и теперь мой проект начинает больше, я пишу dhdx dc и использую объекты docstrings с sphinx.ext.autodoc для включения.

Моя проблема: как сильно форматировать представление docstring?

• Документ GET/POST и многое другое.
• шаблона (ов)
• содержание Контекст

Например, я использую:

def my_view(request): 
    """ 
    Do something depending of HTTP method. 

    In GET: Returns a page 
    IN POST: Make something and redirect 

    GET parameters: 
    GET['next'] : URL to redirect to after submit form 

    POST parameters: 
    POST['action'] : Action 
    """ 

Я себя спрашиваю, есть ли лучший способ сделать это? Есть ли консенсус по этому поводу?

Answer 1

Несколько примеров можно найти здесь: https://docs.djangoproject.com/en/1.8/ref/contrib/admin/admindocs/