mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
f95fd4f052
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.
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
---
|
||
layout: default
|
||
title: "自动生成文档"
|
||
parent: "Chinese (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` - 从 OpenAPI 和 AsyncAPI 规范生成 REST 和 WebSocket 文档。
|
||
|
||
## 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
|
||
```
|
||
|
||
这将生成一个包含完整 API 文档的单个 Markdown 文件，其中包含：
|
||
- 安装和快速入门指南
|
||
- 每个类/类型的导入语句
|
||
- 完整的 docstrings（包含示例）
|
||
- 按类别组织的目录
|
||
|
||
### 文档风格
|
||
|
||
所有 docstrings 均遵循 Google 风格：
|
||
- 简短的一行摘要
|
||
- 详细描述
|
||
- 参数描述的 Args 部分
|
||
- Returns 部分
|
||
- Raises 部分（如果适用）
|
||
- 带有正确语法高亮的代码块（示例）
|
||
|
||
生成的文档显示了用户从 `trustgraph.api` 中导入的公共 API，而无需暴露内部模块结构。
|