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