如何为基于类的视图生成文档?

时间:2017-03-30 07:51:04

标签: python django documentation docutils

Django documentation中,有关于如何记录模型,视图和其他文件的简短信息,以便在Django Admin中轻松使用。但它缺乏关于如何为基于类的视图执行此操作的信息。说我有简单的DetailView

class MyDetailView(DetailView):
    model = MyModel
我写了类似的东西:

class MyDetailView(DetailView):
   """
       Displays single :model:`myApp.MyModel` with all details.

       :template: `myApp/mymodel_detail.html`
    """
    model = MyModel

但是这不会显示为带有模型/模板参考的文档文本。我该怎么办?

1 个答案:

答案 0 :(得分:0)

原来它没有显示:template:,因为冒号后面有额外的空间。