Bina Panduan

Dokument ini menerangkan cara membina dokumen Sphinx bagi aplikasi Parrot. Kami akan mencakup menyediakan suatu lingkungan virtual (venv), memasang pip dan m

Note

Parrot adalah dalam pembangunan awal dan belum bersedia untuk pengguna akhir.

Kata Masukan Pengaturan

Salin repositori: Pertama, salin repositori menggunakan perintah ini:

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

Tukar kedai ke dalam repositori: Selepas klonan, lawati kepada akar projek dengan menjalankan:
```
cd parrot-wtf
```

Sila pasang python3-venv (apt): Ini diperlukan untuk mencipta lingkungan virtuan. Jalankan perintah ini:

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

Tetapkan sebuah ruang lingkungan wajib (venv): Terdapat projek pada direktori akar dan jalankan:
```
python3 -m venv venv
```
Aktifkan lingkungan berjenis: Sebelum memasang sebarang paket, aktifkan lingkungan berjenis dengan menjalankan:
```
source venv/bin/activate
```
Guna requirements.txt: Fail ini mengandungi senarai kebutuhan projek. Untuk memasang mereka menggunakan pip, jalankan:
```
pip install -r requirements.txt
```

Pasang Submodul: Pasang submodul repositori Parrot lain untuk menyertakan dokumen mereka.

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

Membangun Dokumentasi

Bersihkan binaan semasa: Jika anda telah membina dokumen terdahulu, mulakan dengan membersihkan fail-fail bina lama dengan perintah ini:
```
make clean
```
Bangun versi HTML dokumen: Aplikasi Parrot menggunakan Sphinx untuk menciptakan dokumentasi. Untuk membuat versi HTML, jalankan:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Mempancarkan ke Pelayan Web

Selepas membina dokumen, anda akan menjumpai fail HTML dalam direktori build/html. Ini adalah fail-fail yang perlu diunggah ke pelayan web anda.

Kemas kinifail .env untuk mengeset URL pelayan yang digunakan oleh rsync, seperti:

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

Jalankan perintah berikut untuk rsync ke pelayan:

./scripts/rsync-parrot-wtf

Ini akan menempatkan semua fail HTML dalam build/html ke pelayan utama anda.

Note

Dokumentasi Parrot ditulis dalam Bahasa Inggeris dan menggunakan terjemahan mesin untuk bahasa lain.