अपनी दस्तावेज़ बनाएँ

यह दस्तावेज़ किसी प्रोग्राम के लिए Sphinx डॉक्यूमेंट

टिप्पणी

परोट अभी तक प्रारंभिक 開発中 और एंड यूसर्स के लिए तैयार नहीं है।

सेटअप instructions

  1. संग्रहालय के क्लोन करें: पहले यह आदेश का उपयोग करके संग्रहालय का क्लोन करें:

    git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
    
  2. अपने रिपॉजिटरी को स्थानांतरित करें: क्लोनिंग के बाद, कमांड चलाकर प्रोजेक्ट की रूट डायरे

    cd parrot-wtf
    
  3. स्थापित करें python3-venv (apt): इसके लिए विrtual environment बनाने की जरूरत होती है। इस आदेश को चलाएं:

    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 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 अवतरण: Parrot यानि अप्लिकेशन 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
    

वेब सर्वर पर डालें

बदले के बाद, आपको डॉक्यूमेंटेशन बनाने के बाद, build/html डायरेक्टरी में HTML फ़ाइले

एडिट .env करें जो rsync के लिए अधिकारिता के रूप में इस्तेमाल होने वाली URL सेट करने के लिए

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

चालू करें निम्नलिखित आदेश को rsync सर्वर तक:

./scripts/rsync-parrot-wtf

यह सべて의 HTML फ़ाइलें बिल्ड/एचटीएम्ल से मुख्य सर्वर पर पश्त करेगा।

टिप्पणी

पार्ट दस्तावेज़ अंग्रेजी में लिखा गया है और अन्य भाषाओं के लिए AI मशीन ट्रांसलेशन का उपयो