没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
django Admin文档生成器使用详解文档生成器使用详解
主要介绍了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."""
...
资源评论
weixin_38748382
- 粉丝: 6
- 资源: 923
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功