Commit Graph

11 Commits

Author SHA1 Message Date
root
207b1a45d2 docs: kwork-api v1.0 released 2026-03-28 23:24:34 +00:00
root
6ac9c533fa feat: add /api/validation/checktext endpoint with tests
- Add ValidationResponse and ValidationIssue models
- Add client.other.validate_text() method
- Add 3 unit tests for validation endpoint
- Update CI/CD workflow for real test runs
- Update .gitignore for Python projects
- Update documentation and WIP.md
2026-03-28 23:15:16 +00:00
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
root
a6cb7c1f35 docs: обновлён WIP.md с итогами документирования 2026-03-23 04:28:58 +00:00
root
25372e5182 docs: обновлён WIP.md 2026-03-23 04:24:01 +00:00
root
305d934081 docs: обновлён WIP.md 2026-03-23 04:21:18 +00:00
root
e838399910 docs: обновлена документация в WIP.md 2026-03-23 04:19:22 +00:00
root
8d0e504aea docs: переключение на pydoc-markdown для генерации API документации
- Добавлен pydoc-markdown.yml для конфигурации генерации
- Обновлён mkdocs.yml (убран mkdocstrings, упрощена конфигурация)
- Добавлен скрипт scripts/gen_docs.py для автоматической генерации
- Обновлены зависимости в pyproject.toml (dependency-groups вместо dev-dependencies)
- Сгенерирована новая документация в docs/api_reference.md
2026-03-23 04:17:50 +00:00
root
080e5ddc72 Update WIP.md with documentation status 2026-03-23 03:46:30 +00:00
root
70fbc7a035 Update WIP.md with endpoint analysis 2026-03-23 03:17:30 +00:00
fae04b0896 Add WIP.md with project status 2026-03-23 03:01:02 +00:00