docs: обновлена документация в WIP.md

This commit is contained in:
root 2026-03-23 04:19:22 +00:00
parent a5a1ec5970
commit e838399910

25
WIP.md
View File

@ -42,38 +42,29 @@
## 📝 Заметки ## 📝 Заметки
### Автогенерация документации (2026-03-23 04:17) ### Автогенерация документации (2026-03-23 04:19)
**Инструмент:** pydoc-markdown + MkDocs **Инструмент:** pydoc-markdown
**Структура:** **Структура:**
``` ```
docs/ docs/
├── index.md # Quick start ├── index.md # Quick start (ручной)
├── api_reference.md # Auto-generated from docstrings ├── api_reference.md # Auto-generated from docstrings
└── examples.md # Usage examples └── examples.md # Usage examples (ручной)
site/ # Generated HTML (не коммитим)
├── index.html
├── api_reference/
└── ...
``` ```
**Конфигурация:** **Конфигурация:**
- `pydoc-markdown.yml` — конфигурация pydoc-markdown - `pydoc-markdown.yml` — единственная конфигурация для генерации
- `mkdocs.yml` — MkDocs конфигурация
- `scripts/gen_docs.py` — скрипт генерации
**Команды:** **Команды:**
```bash ```bash
# Генерация документации # Генерация документации
uv run python scripts/gen_docs.py uv run python scripts/gen_docs.py
# или
pydoc-markdown > docs/api_reference.md
# Локальный просмотр # Pre-commit hook автоматически генерирует документацию
mkdocs serve
# Сборка
mkdocs build
``` ```
### Аудит эндпоинтов (2026-03-23 03:08) ### Аудит эндпоинтов (2026-03-23 03:08)