בניית תיעוד

המסמך הזה מסביר איך לבנות דוקומנטציה Sphinx עבור היישום Par

הערה

פרוט מוצא בפיתוח מוקדם, לא מוכן עבור משתמשים סופיים.

הוראות הקמת מערכת

קונפיגורציה מחזיקה: תחילה, קונפיגורציה את המחסן באמצעות הפקודה הזו:
```
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 כדי לכלול את מסמך התיעוד שלהם.

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 של המדריכים: ייעוד היילוק משתמש ב-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 כדי לקבוע את כתובת השרת שיהיה משמשת על-ידי rsync, כמו:

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

הרצו את הפקודה הבאה לסינכרון לשרת:

./scripts/rsync-parrot-wtf

זה ידרוש אתכם להעלות את כל קבצי HTML ב- build/html לשרת הראשי שלכם.

הערה

תיעוד הפרטי של פארוט מכתב באנגלית ומשתמש בתרגום מכונה לאנשי מחיنה עבור שפות אחרות.