如何格式化Django视图的文档字符串

Question

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

我的麻烦是：如何大幅格式化视图的文档字符串？

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