mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +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
53
docs/README.api-docs.he.md
Normal file
53
docs/README.api-docs.he.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
layout: default
|
||||
title: "יצירת תיעוד אוטומטית"
|
||||
parent: "Hebrew (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 מהמפרטים של OpenAPI ו-AsyncAPI.
|
||||
|
||||
## תיעוד API בפייתון
|
||||
|
||||
תיעוד ה-API בפייתון נוצר מתוך מחרוזות תיאור (docstrings) באמצעות סקריפט פייתון מותאם, אשר סוקר את החבילה `trustgraph.api`.
|
||||
|
||||
### תנאים מוקדמים
|
||||
|
||||
חבילת `trustgraph` חייבת להיות ניתנת לייבוא. אם אתם עובדים בסביבת פיתוח:
|
||||
|
||||
```bash
|
||||
cd trustgraph-base
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### יצירת תיעוד
|
||||
|
||||
מתוך תיקיית התיעוד:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
python3 generate-api-docs.py > python-api.md
|
||||
```
|
||||
|
||||
זה יוצר קובץ Markdown אחד עם תיעוד API מלא, המציג:
|
||||
- מדריך התקנה והתחלה מהירה
|
||||
- הצהרות ייבוא עבור כל מחלקה/סוג
|
||||
- מחרוזות תיאור מלאות עם דוגמאות
|
||||
- תוכן עזר מאורגן לפי קטגוריות
|
||||
|
||||
### סגנון התיעוד
|
||||
|
||||
כל מחרוזות התיאור עוקבות אחר פורמט Google:
|
||||
- סיכום קצר בשורה אחת
|
||||
- תיאור מפורט
|
||||
- סעיף "Args" עם תיאורי פרמטרים
|
||||
- סעיף "Returns"
|
||||
- סעיף "Raises" (במידת הצורך)
|
||||
- בלוקי קוד לדוגמה עם הדגשת תחביר מתאימה
|
||||
|
||||
התיעוד שנוצר מציג את ה-API הציבורי בדיוק כפי שהמשתמשים מייבאים אותו מ-`trustgraph.api`, מבלי לחשוף את המבנה הפנימי של המודול.
|
||||
Loading…
Add table
Add a link
Reference in a new issue