mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
|
---
|
|||
|
|
layout: default
|
|||
|
|
title: "Otomatik olarak dokümantasyon oluşturma"
|
|||
|
|
parent: "Turkish (Beta)"
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Otomatik olarak dokümantasyon oluşturma
|
|||
|
|
|
|||
|
|
> **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 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.
|