mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-07-09 05:12:12 +02:00
init translations
Signed-off-by: Jenkins, Kenneth Alexander <kjenkins60@gatech.edu>
This commit is contained in:
parent
a74fc38d9d
commit
6ff883acee
87 changed files with 10246 additions and 0 deletions
45
docs/README.api-docs.ru.md
Normal file
45
docs/README.api-docs.ru.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# Автоматическое создание документации
|
||||
|
||||
## Документация REST и WebSocket API
|
||||
|
||||
- `specs/build-docs.sh` - Создает документацию для REST и WebSocket API на основе спецификаций OpenAPI и AsyncAPI.
|
||||
|
||||
## Документация Python API
|
||||
|
||||
Документация Python API генерируется из docstrings с использованием пользовательского скрипта Python, который анализирует пакет `trustgraph.api`.
|
||||
|
||||
### Требования
|
||||
|
||||
Пакет `trustgraph` должен быть импортируемым. Если вы работаете в среде разработки:
|
||||
|
||||
```bash
|
||||
cd trustgraph-base
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Генерация документации
|
||||
|
||||
Из каталога `docs`:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
python3 generate-api-docs.py > python-api.md
|
||||
```
|
||||
|
||||
Это создает один файл Markdown с полной документацией API, в котором показаны:
|
||||
- Инструкции по установке и быстрому запуску
|
||||
- Заявления импорта для каждого класса/типа
|
||||
- Полные docstrings с примерами
|
||||
- Содержание, организованное по категориям
|
||||
|
||||
### Стиль документации
|
||||
|
||||
Все docstrings следуют формату Google-style:
|
||||
- Краткое однострочное описание
|
||||
- Подробное описание
|
||||
- Раздел "Args" с описаниями параметров
|
||||
- Раздел "Returns"
|
||||
- Раздел "Raises" (при необходимости)
|
||||
- Блоки с примерами кода с правильной подсветкой синтаксиса
|
||||
|
||||
Сгенерированная документация отображает публичный API точно так, как его импортируют из `trustgraph.api`, не раскрывая внутреннюю структуру модуля.
|
||||
Loading…
Add table
Add a link
Reference in a new issue