Belge Oluşturma

Bu belge, Parrot uygulaması için Sphinx dokümantasyonunu oluşturmak konusunda size rehberlik eder. Sanal ortam (venv) kur

Not

Parrot en geliştirme aşamasındadır ve son kullanıcılar için hazır değil.

Kurulum Talimatları

Depoyu klonla: İlk olarak, bu komutu kullanarak depoyu klonla:

git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf

Repositörü oyna git: Klonladıktan sonra, projenin kök dizinine giderek çalıştırarak gelin:
```
cd parrot-wtf
```

Python 3-venv’yi kurun (apt): Sanal bir ortam oluşturmak için gereklidir. Bu komutu çalıştırın:

sudo apt update
sudo apt install docutils gettext python3-pip python3-venv
# To build PDFs with LaTeX
sudo apt install texlive-full xindy

Sanal ortam (venv) kurun: Projenizin kök dizinine gidin ve çalıştırın:
```
python3 -m venv venv
```
Sanal ortamı etkinleştirin: Paketleri yükleye başlamadan önce, sanal ortamı çalıştırarak etkinleştirin:
```
source venv/bin/activate
```
requirements.txt kullanın: Bu dosya proje bağımlılıklarının listesini içerir. Tümünü pip kullanarak yüklemek için çalıştırın:
```
pip install -r requirements.txt
```

Alt Modüller Yükle: Diğer Parrot depo alt modülleri belgelerini eklemek için yükleyin.

pip install -r datasets/requirements.txt
pip install -r extension/requirements.txt
pip install -r ide/requirements.txt
pip install -r models/requirements.txt

pip install -e datasets

Dokumentasyonun Oluşturulması

Mevcut derlemeyi temizle: Eğer daha önce belgeleri oluşturmuş iseniz, bu komutla eski derleme dosyalarını temizleyin:
```
make clean
```
Dökümanların HTML sürümünü inşa et: Parrot uygulaması, doküman oluşturmak için Sphinx’i kullanır. HTML sürümünü oluşturmak için çalıştırın:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Sunucuya Gönder

Dökümantasyonun oluşturulduktan sonra, HTML dosyalarını “build/html” dizininde bulacaksınız. Bu, web sunucunuza yüklenmesi gereken dosyalardır.

.env dosyasını, rsync tarafından kullanılacak sunucu URL’sini ayarlamak için düzenleyin; örneğin:

URL="parrot.wtf:/var/www/html/parrot-wtf/"

Sunucuya şu komutla rsync çalıştırın:

./scripts/rsync-parrot-wtf

Bu, tüm HTML dosyalarını “build/html” dan ana sunucuya itecek.

Not

Parrot dokümantasyonu İngilizcede yazılmıştır ve diğer diller için Yapay Zeka makine çevirisi kullanır.