Django3.1教程 Django简介 Django环境安装第一个Django应用 Part 1：请求与响应 Part 2：模型与后台 Part 3：视图和模板 Part 4：表单和类视图 Part 5：测试 Part 6：静态文件 Part 7：自定义admin 第一章：模型层模型和字段关系类型字段字段的参数多对多中间表详解模型的元数据Meta 模型的继承验证器查询操作查询集API 不返回QuerySets的API 注解与聚合第二章：视图层 URL路由基础路由转发反向解析和命名空间视图函数及快捷方式异步视图 HttpRequest对象 QueryDict对象 HttpResponse对象文件上传生成CSV文件生成PDF文件类视图中间件第三章：模版层 Django模板语言详解 Django内置模板标签 Django内置过滤器特殊的标签和过滤器人类可读性自定义标签和过滤器第四章：Django表单使用表单 Django表单API详解 Django表单字段汇总表单的Widgets 模型表单ModelForm 第五章：Admin管理后台自定制Admin 自定义Admin actions Admin文档生成器第六章：Django 综合篇配置 Django 核心配置项使用MySQL数据库 django-admin和manage.py 自定义django-admin命令会话session 网站地图sitemap 信号 signal 序列化 serializers 消息框架 message 分页 Paginator 聚合内容 RSS/Atom 发送邮件 Django 日志 Django与缓存 Authentication CSRF与AJAX 国际化和本地化 contenttypes框架部署 Django 实战一：基于Django2.2可重用登录与注册系统 1. 搭建项目环境 2. 设计数据模型 3. admin后台 4. url路由和视图 5. 前端页面设计 6. 登录视图 7. Django表单 8. 图片验证码 9. session会话 10. 注册视图 11.Django发送邮件 12. 邮件注册确认 13. Github管理项目 14. 重用app 实战二：Django2.2之CMDB资产管理系统 1.项目需求分析 2.模型设计 3.数据收集客户端 4.收集Windows数据 5.Linux下收集数据 6.新资产待审批区 7.审批新资产 8.已上线资产更新 9.前端框架AdminLTE 10.资产总表 11.资产详细页面 12.dashboard仪表盘

Admin文档生成器

阅读: 29432 评论：0

Django的admindocs应用可以从模型、视图、模板标签等地方获得文档内容。

一、概览

要激活admindocs，请按下面的步骤操作：

在INSTALLED_APPS内添加django.contrib.admindocs
在urlpatterns内添加path('admin/doc/', include('django.contrib.admindocs.urls'))。确保它处于'admin/'条目之前，原因你懂的。
安装Python的docutils模块(https://docutils.sourceforge.io/)（pip install docutils)
可选：想使用admindocs的书签小工具，需要安装django.contrib.admindocs.middleware.XViewMiddleware。

如果上述步骤顺利完成，那么你可以从admin界面访问doc界面，也可以直接访问/admin/doc，如下图：

它看起来是下面的样子：

下面的这些特殊标记，可帮助你在文档字符串中，快速创建指向其它组件的链接：

二、模型

在doc页面的模型部分，列出了所有的模型，点击可以查看具体的字段等细节信息。信息主要来自字段的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内置的或者你自定义的或者第三方app提供的标签和过滤器都将在页面内展示：

自定义Admin actions 第六章：Django 综合篇

评论总数： 0

点击登录后方可评论