Commit Graph

6 Commits

Author SHA1 Message Date
root
a771a75c49 docs: добавлены подробные docstrings для KworkClient
- KworkClient: полное описание класса, аутентификации, примеров
- __init__: детальное описание параметров
- login(): пошаговое описание процесса аутентификации
- CatalogAPI: документация класса и методов get_list, get_details, get_details_extra
- ProjectsAPI: документация класса и метода get_list
- get_payer_orders/get_worker_orders: описание методов

Все docstrings на русском языке с примерами использования.
2026-03-23 04:23:49 +00:00
root
706dfde40e docs: убран скрипт gen_docs.py, только pre-commit hook
- Удалена директория scripts/
- Убран gen-docs из pyproject.toml
- Документация генерируется только через pre-commit hook
2026-03-23 04:21:12 +00:00
root
a5a1ec5970 docs: полная миграция на pydoc-markdown (убран MkDocs)
- Удалён mkdocs.yml и вся сгенерированная site/ директория
- pydoc-markdown.yml теперь использует markdown renderer напрямую
- Скрипт gen_docs.py генерирует docs/api_reference.md без MkDocs
- Обновлён pre-commit hook для использования pydoc-markdown
- Убраны зависимости MkDocs из конфигурации

Теперь документация генерируется только через pydoc-markdown.
2026-03-23 04:19:09 +00:00
root
86149e0196 Setup mkdocstrings inline documentation
- Remove custom generate_docs.py script
- Use mkdocstrings inline ::: syntax in markdown files
- docs/api-reference.md: Main API reference with inline docs
- docs/api/*.md: Category pages with inline injections
- Pre-commit: Build mkdocs on commit

Documentation now uses standard mkdocstrings approach.
2026-03-23 03:54:54 +00:00
root
f7ab02d3cf Generate markdown API docs with griffe
- scripts/generate_docs.py: Generate .md files from docstrings
- docs/api/*.md: Auto-generated API documentation
- Pre-commit hook: Auto-generate markdown on commit
- Uses griffe AST parser (no code execution)

Generated files:
- docs/api/index.md
- docs/api/kworkclient.md
- docs/api/client/*.md
- docs/api/models/*.md
- docs/api/errors/*.md
2026-03-23 03:52:07 +00:00
root
104aedbcf4 Update WIP.md with endpoint analysis 2026-03-23 03:26:21 +00:00