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
53
docs/README.api-docs.hi.md
Normal file
53
docs/README.api-docs.hi.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
**महत्वपूर्ण निर्देश:**
|
||||
|
||||
- सभी Markdown फॉर्मेटिंग, हेडर, लिंक और HTML टैग को बरकरार रखें।
|
||||
- बैक टिक (` `) या कोड ब्लॉक के अंदर के कोड का अनुवाद न करें।
|
||||
- केवल अनुवादित पाठ प्रस्तुत करें, बिना किसी प्रारंभिक या स्पष्टीकरण के।
|
||||
|
||||
अनुवाद करने के लिए पाठ:
|
||||
|
||||
# स्वचालित रूप से दस्तावेज़ उत्पन्न करना
|
||||
|
||||
## REST और WebSocket API दस्तावेज़
|
||||
|
||||
- `specs/build-docs.sh` - OpenAPI और AsyncAPI विनिर्देशों से REST और WebSocket दस्तावेज़ बनाता है।
|
||||
|
||||
## पायथन API दस्तावेज़
|
||||
|
||||
पायथन API दस्तावेज़, `trustgraph.api` पैकेज का विश्लेषण करके एक कस्टम पायथन स्क्रिप्ट का उपयोग करके docstrings से उत्पन्न होते हैं।
|
||||
|
||||
### पूर्व आवश्यकताएँ
|
||||
|
||||
trustgraph पैकेज आयात करने योग्य होना चाहिए। यदि आप एक विकास वातावरण में काम कर रहे हैं, तो:
|
||||
|
||||
```bash
|
||||
cd trustgraph-base
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### दस्तावेज़ उत्पन्न करना
|
||||
|
||||
दस्तावेज़ निर्देशिका से:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
python3 generate-api-docs.py > python-api.md
|
||||
```
|
||||
|
||||
यह एक एकल Markdown फ़ाइल उत्पन्न करता है जिसमें संपूर्ण API दस्तावेज़ शामिल है, जिसमें निम्नलिखित शामिल हैं:
|
||||
- स्थापना और त्वरित शुरुआत गाइड
|
||||
- प्रत्येक वर्ग/प्रकार के लिए आयात कथन
|
||||
- पूर्ण docstrings के साथ उदाहरण
|
||||
- श्रेणियों द्वारा व्यवस्थित सामग्री तालिका
|
||||
|
||||
### दस्तावेज़ शैली
|
||||
|
||||
सभी docstrings Google-शैली का पालन करते हैं:
|
||||
- संक्षिप्त एक-पंक्ति सारांश
|
||||
- विस्तृत विवरण
|
||||
- पैरामीटर विवरण के साथ Args अनुभाग
|
||||
- रिटर्न अनुभाग
|
||||
- प्रासंगिक होने पर Raises अनुभाग
|
||||
- उचित सिंटैक्स हाइलाइटिंग के साथ उदाहरण कोड ब्लॉक
|
||||
|
||||
उत्पन्न दस्तावेज़ सार्वजनिक API को ठीक उसी तरह दिखाता है जैसे उपयोगकर्ता इसे `trustgraph.api` से आयात करते हैं, आंतरिक मॉड्यूल संरचना को उजागर किए बिना।
|
||||
Loading…
Add table
Add a link
Reference in a new issue