Генератор документации Django admin

Приложение Django admindocs извлекает документацию из строк документации моделей, представлений, тегов шаблонов и фильтров шаблонов для любого приложения в INSTALLED_APPS и делает эту документацию доступной через Django admin.

Обзор

Для активации admindocs необходимо выполнить следующие действия:

• Добавьте django.contrib.admindocs в свой INSTALLED_APPS.
• Добавьте path('admin/doc/', include('django.contrib.admindocs.urls')) в ваш urlpatterns. Убедитесь, что она включена перед записью 'admin/', чтобы запросы к /admin/doc/ не обрабатывались последней записью.
• Установите модуль Python docutils (https://docutils.sourceforge.io/).
• Необязательно: Использование закладок admindocs требует установки django.contrib.admindocs.middleware.XViewMiddleware.

После выполнения этих шагов можно начать просматривать документацию, перейдя в интерфейс администрирования и нажав ссылку «Документация» в правом верхнем углу страницы.

Инструменты для создания документации

Следующая специальная разметка может использоваться в строках документации для удобного создания гиперссылок на другие компоненты:

Справочник по моделям

Раздел модели на странице admindocs описывает каждую модель в системе вместе со всеми полями, свойствами и методами, доступными для нее. Связи с другими моделями отображаются в виде гиперссылок. Описания извлекаются из атрибутов help_text полей или из строк документации методов модели.

Модель с полезной документацией может выглядеть так:

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."""
        ...

Справочник по представлениям

Каждая ссылка в вашем сайте имеет отдельную запись на странице admindocs и клик по ссылке покажет соответствующее представление. В строках документации вашей функции представления следует документировать:

• Краткое описание того, что делает представление.
• Контекст, или список переменных, доступных в шаблоне представления.
• Имя шаблона или шаблонов, используемых для этого представления.

Например:

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)

Справочник по тегам и фильтрам шаблонов

Разделы теги и фильтры admindocs описывают все теги и фильтры, которые поставляются с Django (фактически, документация справочника по встроенным тегам и справочника по встроенным фильтрам напрямую взята с этих страниц). Любые теги или фильтры, которые вы создали или добавлены сторонним приложением, также будут отображаться в этих разделах.

Справочник по шаблонам

Хотя admindocs не содержит места для документирования шаблонов самостоятельно, если вы используете синтаксис :template:`path/to/template.html` в строке документации, результирующая страница проверит путь этого шаблона с помощью механизмов загрузки шаблонов Django загрузчиков шаблонов. Это может быть полезным способом проверить, существует ли указанный шаблон, и показать, где на файловой системе хранится этот шаблон.

Включенные закладки

Одна закладка доступна на странице admindocs:

Документация для этой страницы

Перемещает вас с любой страницы на документацию для представления, которое генерирует эту страницу.

Использование этой закладки требует установки XViewMiddleware и входа в Django admin как User с is_staff, установленным на True.