kwork-api/docs/api-reference.md
root 127e5927bc docs: переход на MkDocs + mkdocstrings для HTML документации
Рефакторинг:
- OtherAPI упразднён — все методы перемещены в KworkClient
- Методы client.get_wants(), get_kworks_status() и др. теперь напрямую в клиенте
- Удалён property client.other

Документация:
- MkDocs + mkdocstrings + Material theme для HTML сайта
- Навигация, поиск, форматирование кода
- docs/index.md — quick start guide
- docs/api/*.md — API reference с автогенерацией из docstrings
- Pre-commit hook для автогенерации HTML

Зависимости:
- Добавлены: mkdocs, mkdocs-material, mkdocstrings, mkdocstrings-python
- Убран pydoc-markdown (не нужен)

Команды:
- mkdocs build — сборка HTML
- mkdocs serve — локальный просмотр
2026-03-23 04:35:58 +00:00

254 B

API Reference

Complete API documentation for Kwork API client.

Modules

  • Client — Main client class and API groups
  • Models — Pydantic models for API responses
  • Errors — Exception classes