docs: обновлена документация в WIP.md
This commit is contained in:
parent
a5a1ec5970
commit
e838399910
25
WIP.md
25
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)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user