apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-07-09 13:22:10 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

add more docs

Browse source 
Signed-off-by: Jenkins, Kenneth Alexander <kjenkins60@gatech.edu>
This commit is contained in:
Jenkins, Kenneth Alexander 2026-04-10 12:22:20 -04:00
parent 23e18cd562
commit 835acaa70e
No known key found for this signature in database
94 changed files with 60854 additions and 1126 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/README.api-docs.tr.md Normal file
View file

@ -0,0 +1,48 @@
# Otomatik olarak dokümantasyon oluşturma
## REST ve WebSocket API Dokümantasyonu
`specs/build-docs.sh` - REST ve websocket dokümantasyonunu OpenAPI ve AsyncAPI özelliklerinden oluşturur.
## Python API Dokümantasyonu
Python API dokümantasyonu, `trustgraph.api` paketini inceleyen özel bir Python betiği kullanılarak, dokümantasyon dizelerinden (docstrings) oluşturulur.
### Ön Koşullar
trustgraph paketi içe aktarılabilir olmalıdır. Geliştirme ortamında çalışıyorsanız:
```bash
cd trustgraph-base
pip install -e .
```
### Belgeler Oluşturma
"docs" dizininden:
```bash
cd docs
python3 generate-api-docs.py > python-api.md
```
Bu, eksiksiz API dokümantasyonunu içeren tek bir Markdown dosyası oluşturur ve şunları gösterir:
Kurulum ve hızlı başlangıç kılavuzu
Her sınıf/tip için içe aktarma ifadeleri
Örneklerle birlikte tam dokümanlar
Kategoriye göre düzenlenmiş içindekiler tablosu
### Dokümantasyon Stili
Tüm dokümanlar, Google stili biçimini izler:
Kısa, tek satırlık özet
Ayrıntılı açıklama
Parametre açıklamalarıyla birlikte "Args" bölümü
"Returns" bölümü
"Raises" bölümü (uygulanabilir olduğunda)
Doğru sözdizimi vurgulamasıyla birlikte örnek kod blokları
Oluşturulan dokümantasyon, kullanıcıların `trustgraph.api`'dan içe aktardığı şekilde, tam olarak kamu API'sini gösterir ve dahili modül yapısını ortaya çıkarmaz.