django - 如何格式化 Django View 的文档字符串

Question

我在我的项目中使用简单的 View ，现在我的项目开始变得更大，我正在编写一个 sphinx 文档并使用对象文档字符串 sphinx.ext.autodoc为包含。

我的问题是:如何大大格式化 View 的文档字符串？

记录 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/