From e83839991097dce010706adc1320b1cbd7a5fc04 Mon Sep 17 00:00:00 2001 From: root Date: Mon, 23 Mar 2026 04:19:22 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D0=B0=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=B2=20WIP.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- WIP.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/WIP.md b/WIP.md index a2252b0..ece8bb9 100644 --- a/WIP.md +++ b/WIP.md @@ -42,38 +42,29 @@ ## 📝 Заметки -### Автогенерация документации (2026-03-23 04:17) +### Автогенерация документации (2026-03-23 04:19) -**Инструмент:** pydoc-markdown + MkDocs +**Инструмент:** pydoc-markdown **Структура:** ``` docs/ -├── index.md # Quick start +├── index.md # Quick start (ручной) ├── api_reference.md # Auto-generated from docstrings -└── examples.md # Usage examples - -site/ # Generated HTML (не коммитим) -├── index.html -├── api_reference/ -└── ... +└── examples.md # Usage examples (ручной) ``` **Конфигурация:** -- `pydoc-markdown.yml` — конфигурация pydoc-markdown -- `mkdocs.yml` — MkDocs конфигурация -- `scripts/gen_docs.py` — скрипт генерации +- `pydoc-markdown.yml` — единственная конфигурация для генерации **Команды:** ```bash # Генерация документации uv run python scripts/gen_docs.py +# или +pydoc-markdown > docs/api_reference.md -# Локальный просмотр -mkdocs serve - -# Сборка -mkdocs build +# Pre-commit hook автоматически генерирует документацию ``` ### Аудит эндпоинтов (2026-03-23 03:08)