宜配屋

django Admin文档生成器使用详解

yipeiwu_com5年前 (2020-03-06)Python基础

前言

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)