สร้างคู่มือ

กำหนดเอกสารนี้จะพูดถึงวิธีการสร้างเอกสาร Sphinx สำหร

Note

พารอตอยู่ในขั้นตอนการพัฒนาที่เร็วไปหาการใช้งานลูกค้าสุดท้าย ยังไม่พร้อม

การติดตั้งทีละขั้นตอน

ตั้งค่าโปรเจกต์นี้: ก่อนอื่น ให้ทำการโคลนโปรเจกต์โดยใช้คำสั่งนี้:
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
เปลี่ยนไดเรกทอรีโปรเจ็ค: หลังจากที่โคลนแล้ว ให้นำทางไปยังไดเรกทอรีรูตของโปรเจ็คโดยรัน:
```
cd parrot-wtf
```
ติดตั้ง python3-venv (apt): ทำสำหรับการสร้างสภาพแวดล้อมที่ประยุกต์ โปรดรันคำสั่งนี้:
```
sudo apt update
sudo apt install docutils gettext python3-pip python3-venv
# To build PDFs with LaTeX
sudo apt install texlive-full xindy
```
ตั้งค่าสภาพแวดล้อมที่จำกัด (venv): ให้นำทางไปยังโฟลเดอร์ริشทัวร์ของโปรเจคของคุณและรัน:
```
python3 -m venv venv
```
เปิดสภาพแวดล้อมแ��ตล์: ก่อนที่จะติดตั้งแพ็คเกจใด ๆ ให้เปิดสภาพแวดล้อมแ��ตล์โดย运行:
```
source venv/bin/activate
```
ใช้ requirements.txt: ไฟล์นี้ประกอบด้วยรายการของความต้องการโปรเจ็ค ในการติดตั้งพวกเขาโดยใช้ pip �
```
pip install -r requirements.txt
```
ติดตั้งสาขาย่อย: ติดตั้งสาขาย่อยของโครงการ Parrot เพื่อรวมทีละ documentation ให้เข้ากัน.
```
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
```

การเขียนเอกสารและติดตั้ง

ล้างการบิลด์ที่มีอยู่: ถ้าคุณได้สร้างเอกสารและต้องการล้างการบิลด์ภาษาไทยให้ใช้
```
make clean
```
สร้างเวอร์ชัน HTML ของคู่มือ: แอปพลิเคชัน Parrot ใช้ Sphinx เพื่อสร้างการเจดีย์ของตัวมันเอง
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

ส่งไปยังเว็บเซิร์ฟเวอร์

หลังจากสร้างคำแนะนำสมุด, คุณจะพบไฟล์ HTML ในโฟลเดอร์ build/html เหล่านี้เป็นไฟล์ท

แก้ไข .env เพื่อตั้งค่า URL เซิร์ฟเวอร์ที่จะใช้โดย rsync เช่น:

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

เรียกใช้คำสั่งต่อไปนี้เพื่อ rsync ไปยังเซิร์ฟเวอร์:

./scripts/rsync-parrot-wtf

จะส่งไฟล์ HTML ทั้งหมดใน "build/html" ไปยังเซิร์ฟเวอร์หลักของคุณ

Note

เอกสารคู่มือของ Parrot เขียนด้วยภาษาอังกฤษและใช้แปลงภาษาของเครื่องมือตัวทำแบบไหนสำหรับภาษาอื่น �