阅读: 15148 评论:0


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,如下图:

Admin文档生成器 - 图1

它看起来是下面的样子:

Admin文档生成器 - 图2

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

Admin文档生成器 - 图3

二、模型

在doc页面的模型部分,列出了所有的模型,点击可以查看具体的字段等细节信息。信息主要来自字段的help_txt部分和模型方法的docstring部分。如下面图中展示:

有用的帮助信息看起来是这个样子的:

  1. class BlogEntry(models.Model):
  2. """
  3. Stores a single blog entry, related to :model:`blog.Blog` and
  4. :model:`auth.User`.
  5. """
  6. slug = models.SlugField(help_text="A short label, generally used in URLs.")
  7. author = models.ForeignKey(
  8. User,
  9. models.SET_NULL,
  10. blank=True, null=True,
  11. )
  12. blog = models.ForeignKey(Blog, models.CASCADE)
  13. ...
  14. def publish(self):
  15. """Makes the blog entry live on the site."""
  16. ...

Admin文档生成器 - 图4

Admin文档生成器 - 图5

三、视图

站点内的每个URL都会在doc内享有一个页面,点击某个URL将会展示对应的视图信息。主要包括下面这些信息,请尽量丰富它们:

  • 视图功能的简单描述
  • 上下文环境,或者视图模块里的变量列表
  • 视图内使用的模板

例如:

  1. from django.shortcuts import render
  2. from myapp.models import MyModel
  3. def my_view(request, slug):
  4. """
  5. Display an individual :model:`myapp.MyModel`.
  6. **Context**
  7. ``mymodel``
  8. An instance of :model:`myapp.MyModel`.
  9. **Template:**
  10. :template:`myapp/my_template.html`
  11. """
  12. context = {'mymodel': MyModel.objects.get(slug=slug)}
  13. return render(request, 'myapp/my_template.html', context)

Admin文档生成器 - 图6

四、模板标签和过滤器

所有Django内置的或者你自定义的或者第三方app提供的标签和过滤器都将在页面内展示:

Admin文档生成器 - 图7

Admin文档生成器 - 图8