Bersama Membangun Dokumentasi

Dokumen ini menjelaskan cara membangun dokumentasi Sphinx untuk aplikasi Parrot. Kita akan mencakup pengaturan lingkungan virtual (venv), menginstal pip

Catatan

Parrot masih dalam pengembangan awal dan tidak siap untuk pengguna akhir.

Petunjuk Pemasangan

Klon repositori: Pertama, klon repositori menggunakan perintah berikut:

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

Mengubah direktori ke dalam repositori: Setelah mengkloning, bernavigasi ke direktori akar proyek dengan menjalankan:
```
cd parrot-wtf
```

Instalasi python3-venv (apt): Ini diperlukan untuk membuat lingkungan virtual. 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

Konfigurasi lingkungan virtual (venv): Beralih ke direktori akar proyek Anda dan jalankan:
```
python3 -m venv venv
```
Aktifkan lingkungan virtual: Sebelum menginstal paket apa pun, aktifkan lingkungan virtual dengan menjalankan:
```
source venv/bin/activate
```
Gunakan requirements.txt: Berkas ini berisi daftar dependensi proyek. Untuk menginstalnya menggunakan pip, jalankan:
```
pip install -r requirements.txt
```

Instal Submodul: Pasang submodul repositori lain Parrot untuk menyertakan dokumentasinya.

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 Dokumen

Bersihkan bangunan sebelumnya: Jika Anda telah membangun dokumentasi sebelumnya, mulailah dengan membersihkan file bangunan lama dengan perintah ini:
```
make clean
```
Bangun versi HTML dari dokumen: Aplikasi Burung gunakan Sphinx untuk menghasilkan dokumentasinya. 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
```

Kirim ke Peladen Web

Setelah membangun dokumentasi, Anda akan menemukan file HTML di direktori build/html. Ini adalah file yang perlu diunggah ke server web Anda.

Taruh URL server yang akan digunakan oleh rsync di .env, misalnya:

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

Jalankan perintah berikut untuk rsync ke server:

./scripts/rsync-parrot-wtf

Ini akan mengirimkan semua file HTML di build/html ke server utama Anda.

Catatan

Dokumensi Parrot ditulis dalam bahasa Inggris dan menggunakan terjemahan mesin untuk bahasa lain.