django Admin文档生成器使用详解
更新时间：2019年07月22日 14:40:49 作者：NAVYSUMMER
这篇文章主要介绍了django Admin文档生成器,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
前言
Django的admindocs应用可以从模型、视图、模板标签等地方获得文档内容。
一、概览
要激活admindocs，请按下面的步骤操作：
- 在INSTALLED_APPS内添加django.contrib.admindocs
- 在urlpatterns内添加url(r'^admin/doc/',include('django.contrib.admindocs.urls'))。确保它处于r'^admin/'条目之前，原因你懂的。
- 安装Python的docutils模块(http://docutils.sf.net/)(pip3 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提供的标签和过滤器都将在页面内展示：
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
使用python读写txt和json(jsonl)大文件的方法步骤
在Python中读取txt和json(jsonl)大文件并保存到字典是一项非常常见的操作,这篇文章主要给大家介绍了关于使用python读写txt和json(jsonl)大文件的方法步骤,需要的朋友可以参考下2023-12-12
这篇文章主要介绍了安装pytorch时报sslerror错误的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-05-05
今天小编就为大家分享一篇关于Python时间序列处理之ARIMA模型的使用讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2019-04-04
这篇文章主要介绍了Pytorch BertModel的使用说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-03-03
这篇文章主要介绍了关于python的xlwings与VBA间的互相调用,VBA是一种通用应用软件脚本语言，Excel包含和许多功能强大的数据分析对象，例如工作表、图表、数据透视表以及大量的数学、财务、工程和通用业务函数，配合VBA可以运用这些对象开发出自动程序2023-07-07
这篇文章主要介绍了编写Python脚本来获取mp3文件tag信息的教程,代码基于Python2.x,文中的注释很详细,需要的朋友可以参考下2015-05-05
这篇文章主要介绍了python 协程并发数控制，文章基于python的相关资料展开对主题烦人详细内容介绍，需要的小伙伴可以参考一下2022-05-05
这篇文章主要介绍了VSCode 配置使用 PyLint 语法检查器,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-06-06
Pandas是一个非常强大的数据操作python包,支持各种数据格式,包括CSV文件,本文就来介绍一下Python Pandas处理csv文件常用示例,感兴趣的可以了解一下2023-12-12
下面小编就为大家带来一篇浅谈Python爬取网页的编码处理。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2016-11-11
最新评论