Встречается на собеседованиях • сегодня

Какие библиотеки использовал для написания документации на Django

Для документации Django-проектов чаще всего используют:

  1. Sphinx - основной инструмент, интегрируется с reStructuredText (RST). Позволяет генерировать HTML/PDF/Epub. Пример conf.py:
python
extensions = ['sphinx.ext.autodoc']
  1. MkDocs - альтернатива для Markdown-документации. Проще в настройке, но менее гибкий. Пример mkdocs.yml:
yaml
site_name: My Project
theme: readthedocs
  1. Swagger/OpenAPI - для API-документации через drf-yasg или drf-spectacular:
python
# drf-yasg example
from drf_yasg import openapi
schema_view = get_schema_view(openapi.Info(...))
  1. Django's built-in - admindocs для автоматической документации моделей/форм/шаблонов:
python
INSTALLED_APPS += ['django.contrib.admindocs']

Для проектов на ReadTheDocs часто комбинируют Sphinx с sphinx-rtd-theme. Для API популярны ReDoc и Swagger UI.

Sophi
Софи собрала все вопросы. Тренируйся и получай
офферы быстрее!
Попробовать бесплатноArrow

Следующий вопрос

Это единственный вопрос по вашему фильтру

как отвечать на вопрос
пример собеседования
фреймворки на собеседовании
типичные вопросы junior
интервью вопросы и ответы