如何格式化Django视图的docstring

发布时间：2020-12-20 13:45:56 所属栏目：Python 来源：网络整理

导读：我在我的项目中使用简单的视图,现在我的项目开始变大,我正在编写一个sphinx文档,并使用sphinx.ext.autodoc包含对象docstrings. 我的麻烦是：如何大大地格式化视图的文档字符串？文档GET / POST和更多行为. 使用的模板上下文内容例如,我正在使用： def my_

我在我的项目中使用简单的视图,现在我的项目开始变大,我正在编写一个sphinx文档,并使用sphinx.ext.autodoc包含对象docstrings.

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

>文档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
    """

我是自我询问是否有更好的方法来做到这一点？
关于它有什么共识吗？

解决方法

您可以在此处找到一些示例：
https://docs.djangoproject.com/en/1.8/ref/contrib/admin/admindocs/

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!