如何为基于 Class 的视图生成文档？

Question

Django documentation 中有关于如何记录模型、视图和其他文件以便在 Django 管理中轻松使用的简短信息。但它缺少有关如何为基于 class 的视图执行此操作的信息。假设我有简单的 DetailView:

class MyDetailView(DetailView):
    model = MyModel

我这样写：

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

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

但这不会显示为引用 models/templates 的文档文本。我该怎么做？

Answer 1

原来它没有显示 :template:，因为冒号后面多了一个不必要的 space。

如何为基于 Class 的视图生成文档？

How to generate documentation for a Class-based View?

python

django

documentation

docutils