Генератор документации Django админ-панели

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

Обзор

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

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

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

Справочные инструменты документации

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

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

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

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

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.