Django 管理文档生成器

要激活，你需要执行以下操作：

将 django.contrib.admindocs 添加到你的中。
将 path('admin/doc/', include('django.contrib.admindocs.urls')) 加入到你的 urlpatterns 中。确保它被包含在 'admin/' 条目之前，这样对 /admin/doc/ 的请求就不会被后者处理。
安装 docutils Python 模块（https://docutils.sourceforge.io/）。

一旦这些步骤完成，你就可以进入你的管理界面，点击页面右上方的“文档”链接，开始浏览文档。

文件辅助功能

下面的特殊标记可以在你的 docstrings 中使用，以方便创建超链接到其他组件。

一个具有有用文档的模型可能是这样的：

视图参考

在你的网站中，每个 URL 在 admindocs 页面中都有一个单独的条目，点击给定的 URL 会显示相应的视图。你可以在视图函数 docstrings 中记录的有用内容包括：

简要说明该视图的作用。
视图模板中的 上下文，或可用的变量列表。
用于该视图的一个或多个模板的名称。

例子：

from django.shortcuts import render
from myapp.models import MyModel
def my_view(request, slug):
    """
    Display an individual :model:`myapp.MyModel`.
    **Context**
        An instance of :model:`myapp.MyModel`.
    **Template:**
    :template:`myapp/my_template.html`
    """
    context = {'mymodel': MyModel.objects.get(slug=slug)}

模板参考

虽然 admindocs 并不包含记录模板本身的地方，但如果你在 docstring 中使用 :template:`path/to/template.html 语法，生成的页面会用 Django 的验证模板的路径。这是个很方便的方法来检查指定的模板是否存在，并显示该模板在文件系统中的位置。

在 admindocs 页面上有一个书签：

关于本页面的文档

使用这个书签需要安装 XViewMiddleware，并且你以一个 User 的身份登录到，并且 is_staff 设置为。