بنائی توثیق

یہ دستاویز کیسے Sphinx ڈاکیمنٹیشن بنائیں پاررائٔت کی

Note

پرارت در مرحله اولیه توسعه است، آن را برای کاربران نهایی آزاد کنید.

ترتیب کا آغاز

  1. Clone the repository: First, clone the repository using this command:

    git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
    
  2. استعمال کے دیریخت میں ریپوزٹری جائے: گلونڈ کے بعد، پروجیکٹ کا ریپوزٹری کی شکل میں جا

    cd parrot-wtf
    
  3. انٹال کریں 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
    
  4. کا ایک ورٹوال بیٹحال (venv): آپ کے پروجیکٹ کی مکمل شاخہ میں جائیے اور چلیں:

    python3 -m venv venv
    
  5. کانفیگ ورت ملکی کا اشتغال کریں: قبل سے کوئی پیکجز چھوڑنے سے، ابتدائی ورت ملکی کو ران کرنے

    source venv/bin/activate
    
  6. استعمال کریں requirements.txt: یہ فائل پروجیکٹ کی زیادہ پروجیکٹس کی فہرست حاصل کرتی ہے۔ کے pip سے انش

    pip install -r requirements.txt
    
  7. سبموڈیلز کا ترجمہ کریں: دیگر 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
    

بناء التوثيق

  1. موجودہ بیلڈنگ کو تیار کریں: اگر آپ نے پہلے ہی دستاویزات کی بنائی کی ہے تو، اس کام

    make clean
    
  2. بنائے دوکس کے HTML مرضی کے ساتھ: پرارٹ کی طرف سے Sphinx کا استعمال ہوتا ہے تجربہ کی توثی

    make html
    
  3. Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:

    make help
    

وب سرバر تے ڈالیں

After building the documentation, you will find the HTML files in the build/html directory. These are the files that need to be uploaded to your web server.

ترمیم کریں .env اس کے سرور کا URL بنائے جاسکدا "rsync"، اس طرح کی تیسری کے لیے:

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

اسے اتناؤ کمانڈ کو سرور تک rsync کیجئے:

./scripts/rsync-parrot-wtf

اسے سبھی ہت کے HTML فائلیں build/html میں سے آپکے مین سرور پر لگائے گی۔.

Note

پاروٹ ڈاکیومنٹیشن انگریزی میں لکھی جاتی ہے اور دوسرے زبانوں کے لئے AI ماشین ٹرانسلیشن کا اس