下面列出的网站内容(自定义Django的admindocs应用可以从模型、视图、模板标签等地方获得文档内容)
优采云 发布时间: 2022-01-17 19:16下面列出的网站内容(自定义Django的admindocs应用可以从模型、视图、模板标签等地方获得文档内容)
管理文档*敏*感*词*读取:22808:0
Django 的 admindocs 应用程序可以从模型、视图、模板标签等中获取文档内容。
一、概览
要激活 admindocs,请按照以下步骤操作:
如果以上步骤都成功完成,那么可以从admin界面访问doc界面,也可以直接访问/admin/doc,如下图:
看起来像这样:
以下特殊标签可以帮助您在文档字符串中快速创建指向其他组件的链接:
二、型号
doc页面的model部分,列出了所有model,点击查看具体字段等详细信息。信息主要来自字段的help_txt部分和模型方法的docstring部分。如下图所示:
有用的帮助信息如下所示:
class BlogEntry(models.Model):
"""
Stores a single blog entry, related to :model:`blog.Blog` and
:model:`auth.User`.
"""
slug = models.SlugField(help_text="A short label, generally used in URLs.")
author = models.ForeignKey(
User,
models.SET_NULL,
blank=True, null=True,
)
blog = models.ForeignKey(Blog, models.CASCADE)
...
def publish(self):
"""Makes the blog entry live on the site."""
...
三、查看
站点中的每个 URL 都会在 doc 中有一个页面,点击一个 URL 会显示相应的视图信息。主要包括以下信息,请尽量丰富:
例子:
from django.shortcuts import render
from myapp.models import MyModel
def my_view(request, slug):
"""
Display an individual :model:`myapp.MyModel`.
**Context**
``mymodel``
An instance of :model:`myapp.MyModel`.
**Template:**
:template:`myapp/my_template.html`
"""
context = {'mymodel': MyModel.objects.get(slug=slug)}
return render(request, 'myapp/my_template.html', context)
四、模板标签和过滤器
所有内置于 Django 或由您的自定义或第三方应用程序提供的标签和过滤器都将显示在页面上:
自定义管理操作第 6 章:综合 Django