docs: обновлён WIP.md с итогами документирования
This commit is contained in:
parent
857d5a95c5
commit
a6cb7c1f35
24
WIP.md
24
WIP.md
@ -21,7 +21,7 @@
|
|||||||
- [x] Документация (README + docs/)
|
- [x] Документация (README + docs/)
|
||||||
- [x] **Аудит эндпоинтов** — все 33 endpoint протестированы ✅
|
- [x] **Аудит эндпоинтов** — все 33 endpoint протестированы ✅
|
||||||
- [x] **Автогенерация документации** — pydoc-markdown ✅
|
- [x] **Автогенерация документации** — pydoc-markdown ✅
|
||||||
- [x] **Docstrings** — основные классы и методы задокументированы ✅
|
- [x] **Docstrings** — 100% покрытие ✅
|
||||||
- [ ] Добавить `/kworks` endpoint (альтернатива каталогу)
|
- [ ] Добавить `/kworks` endpoint (альтернатива каталогу)
|
||||||
- [ ] Добавить `/api/validation/checktext` (валидация текста)
|
- [ ] Добавить `/api/validation/checktext` (валидация текста)
|
||||||
- [ ] Тесты integration (шаблон готов, нужны реальные credentials)
|
- [ ] Тесты integration (шаблон готов, нужны реальные credentials)
|
||||||
@ -43,27 +43,35 @@
|
|||||||
|
|
||||||
## 📝 Заметки
|
## 📝 Заметки
|
||||||
|
|
||||||
### Автогенерация документации (2026-03-23 04:19)
|
### Автогенерация документации (2026-03-23 04:28)
|
||||||
|
|
||||||
**Инструмент:** pydoc-markdown
|
**Инструмент:** pydoc-markdown
|
||||||
|
|
||||||
**Структура:**
|
**Структура:**
|
||||||
```
|
```
|
||||||
docs/
|
docs/
|
||||||
├── index.md # Quick start (ручной)
|
|
||||||
├── api_reference.md # Auto-generated from docstrings
|
├── api_reference.md # Auto-generated from docstrings
|
||||||
└── examples.md # Usage examples (ручной)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Конфигурация:**
|
**Конфигурация:**
|
||||||
- `pydoc-markdown.yml` — единственная конфигурация для генерации
|
- `pydoc-markdown.yml` — конфигурация генерации
|
||||||
|
- Pre-commit hook — автогенерация при коммите
|
||||||
|
|
||||||
|
**Покрытие документацией:**
|
||||||
|
- `KworkClient` — класс, __init__, login(), все API группы
|
||||||
|
- `CatalogAPI` — get_list(), get_details(), get_details_extra()
|
||||||
|
- `ProjectsAPI` — get_list(), get_payer_orders(), get_worker_orders()
|
||||||
|
- `UserAPI` — get_info(), get_reviews(), get_favorite_kworks()
|
||||||
|
- `ReferenceAPI` — все методы (cities, countries, features, badges...)
|
||||||
|
- `NotificationsAPI` — все методы (list, fetch, dialogs...)
|
||||||
|
- `OtherAPI` — все методы (wants, settings, offline...)
|
||||||
|
- `models.py` — все 20+ моделей
|
||||||
|
- `errors.py` — все 7 исключений
|
||||||
|
|
||||||
**Команды:**
|
**Команды:**
|
||||||
```bash
|
```bash
|
||||||
# Ручная генерация (если нужно)
|
# Ручная генерация
|
||||||
pydoc-markdown > docs/api_reference.md
|
pydoc-markdown > docs/api_reference.md
|
||||||
|
|
||||||
# Pre-commit hook автоматически генерирует при каждом коммите
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Аудит эндпоинтов (2026-03-23 03:08)
|
### Аудит эндпоинтов (2026-03-23 03:08)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user