apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-04-25 00:16:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
trustgraph/docs/README.api-docs.ru.md
Alex Jenkins 8954fa3ad7 Feat: TrustGraph i18n & Documentation Translation Updates (#781) 
Native CLI i18n: The TrustGraph CLI has built-in translation support
that dynamically loads language strings. You can test and use
different languages by simply passing the --lang flag (e.g., --lang
es for Spanish, --lang ru for Russian) or by configuring your
environment's LANG variable.

Automated Docs Translations: This PR introduces autonomously
translated Markdown documentation into several target languages,
including Spanish, Swahili, Portuguese, Turkish, Hindi, Hebrew,
Arabic, Simplified Chinese, and Russian.
2026-04-14 12:08:32 +01:00

2.3 KiB
Raw Permalink Blame History

layout title parent
default Автоматическое создание документации Russian (Beta)

Автоматическое создание документации

Beta Translation: This document was translated via Machine Learning and as such may not be 100% accurate. All non-English languages are currently classified as Beta.

Документация REST и WebSocket API

  • specs/build-docs.sh - Создает документацию для REST и WebSocket API на основе спецификаций OpenAPI и AsyncAPI.

Документация Python API

Документация Python API генерируется из docstrings с использованием пользовательского скрипта Python, который анализирует пакет trustgraph.api.

Требования

Пакет trustgraph должен быть импортируемым. Если вы работаете в среде разработки:

cd trustgraph-base
pip install -e .

Генерация документации

Из каталога docs:

cd docs
python3 generate-api-docs.py > python-api.md

Это создает один файл Markdown с полной документацией API, в котором показаны:

  • Инструкции по установке и быстрому запуску
  • Заявления импорта для каждого класса/типа
  • Полные docstrings с примерами
  • Содержание, организованное по категориям

Стиль документации

Все docstrings следуют формату Google-style:

  • Краткое однострочное описание
  • Подробное описание
  • Раздел "Args" с описаниями параметров
  • Раздел "Returns"
  • Раздел "Raises" (при необходимости)
  • Блоки с примерами кода с правильной подсветкой синтаксиса

Сгенерированная документация отображает публичный API точно так, как его импортируют из trustgraph.api, не раскрывая внутреннюю структуру модуля.