mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 00:16:23 +02:00
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.
This commit is contained in:
parent
f976f1b6fe
commit
8954fa3ad7
560 changed files with 236300 additions and 99 deletions
54
docs/README.api-docs.pt.md
Normal file
54
docs/README.api-docs.pt.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
layout: default
|
||||
title: "Geração automática de documentação"
|
||||
parent: "Portuguese (Beta)"
|
||||
---
|
||||
|
||||
# Geração automática de documentação
|
||||
|
||||
> **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.
|
||||
|
||||
## Documentação da API REST e WebSocket
|
||||
|
||||
`specs/build-docs.sh` - Constrói a documentação REST e WebSocket a partir das
|
||||
especificações OpenAPI e AsyncAPI.
|
||||
|
||||
## Documentação da API Python
|
||||
|
||||
A documentação da API Python é gerada a partir de docstrings usando um script Python personalizado que inspeciona o pacote `trustgraph.api`.
|
||||
|
||||
### Pré-requisitos
|
||||
|
||||
O pacote trustgraph deve ser importável. Se você estiver trabalhando em um ambiente de desenvolvimento:
|
||||
|
||||
```bash
|
||||
cd trustgraph-base
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Gerando Documentação
|
||||
|
||||
A partir do diretório de documentação:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
python3 generate-api-docs.py > python-api.md
|
||||
```
|
||||
|
||||
Isso gera um único arquivo Markdown com documentação completa da API, mostrando:
|
||||
Instruções de instalação e guia de início rápido
|
||||
Declarações de importação para cada classe/tipo
|
||||
Documentação completa com exemplos
|
||||
Sumário organizado por categoria
|
||||
|
||||
### Estilo da Documentação
|
||||
|
||||
Todas as documentações seguem o formato do Google:
|
||||
Resumo breve de uma linha
|
||||
Descrição detalhada
|
||||
Seção "Args" com descrições dos parâmetros
|
||||
Seção "Returns"
|
||||
Seção "Raises" (quando aplicável)
|
||||
Blocos de código de exemplo com realce de sintaxe adequado
|
||||
|
||||
A documentação gerada mostra a API pública exatamente como os usuários a importam de `trustgraph.api`, sem expor a estrutura interna do módulo.
|
||||
Loading…
Add table
Add a link
Reference in a new issue