بناء التوثيق

هذا المستند يشرح كيفية بناء توثيق Sphinx لتطبيق Parrot. سنتعquerح

ملاحظة

قاعدة البروت في مرحلة التطوير الأولى، غير جاهزة للمستخدمين النهائيين.

التعليمات الإعدادية

قم باستنساخ المستودع: أولاً، استنسخ المستودع باستخدام هذا الأمر:
```
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 للوثائق: يستخدم التطبيق "Parrot" نظام Sphinx لتوليد وثائقه. لإنشاء إصدار HTML، قم بت
```
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/"

قم بتشغيل الأمر التالي لـ rsync إلى الخادم:

./scripts/rsync-parrot-wtf

احطي الملفات HTML بالكامل في "build/html" إلى الخادم الرئيسي.

ملاحظة

توثيقات البروت المستندات كتبت باللغة الإنجليزية وتستخدم ترجمة الآلة الذكية للغات أخرى.