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

Приложение Django admindocs извлекает документацию из docstring моделей, представлений, тегов шаблонов и фильтров шаблонов для любого приложения в 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.

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

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

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

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

Раздел модели на странице admindocs описывает каждую модель в системе вместе со всеми полями, свойствами и методами, доступными для неё. Связи с другими моделями отображаются как гиперссылки. Описания извлекаются из атрибутов help_text полей или из 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."""
        ...

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

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

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

Например:

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` в docstring, результирующая страница проверит путь этого шаблона с помощью загрузчиков шаблонов Django. Это может быть полезным способом проверить, существует ли указанный шаблон, и показать, где на файловой системе хранится этот шаблон.

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

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

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

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

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