I-build ang Dokumentasyon

Ang dokumento na ito ay nag-aaralan kung paano makabuo ng Sphinx documentation para sa Parrot application. Tatawagan din nating i-setup ang virtual environment (venv), mag-install ng pip at

Note

Ang Parrot ay nasa una na development, hindi pa handa para sa mga gumagamit na huli.

Katahimikang Instruksyon

  1. Klonan ang repository: Unang pa, klokan ang repository gamit ang command na ito:

    git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
    
  2. Palitan ang direktoryo sa repository: Pagkatapos mag-clone, lumayo sa root directory ng proyekto ay panatilihin:

    cd parrot-wtf
    
  3. Magpalagay ng python3-venv (apt): Kinakailangan ito para sa paglikha ng virtuwal na lugar. Mag-run ng mga sumusunod na kommeng:

    sudo apt update
    sudo apt install docutils gettext python3-pip python3-venv
    # To build PDFs with LaTeX
    sudo apt install texlive-full xindy
    
  4. Mag-set up ng virtual environment (venv): Pumunta sa root directory ng iyong proyekto at paganahin:

    python3 -m venv venv
    
  5. Mag-activate ang virtual environment: Bago mag-install ng mga pakete, mag-activate ang virtual environment sa pamamagitan ng pagtatakip:

    source venv/bin/activate
    
  6. Gumamit ng requirements.txt: Naglalaman ang file na ito ng isang talaan ng mga kailangan ng proyekto. Upang mag-install sila gamit ang pip, i-run ang:

    pip install -r requirements.txt
    
  7. Mag-install ng mga Submodule: Mag-install ng ibang mga submodule ng Parrot repository upang makabago ang kanilang dokumentasyon.

    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
    

Pagsinasagup ng Dokumentasyon

  1. I-clean ang eksisting na pagkabuo: Kung nakalaan mo na ibuild ang dokumentasyon, magsimula ka sa paglilinis ng daw maging luma na mga file ng pagkabuo gamit ang command na ito:

    make clean
    
  2. Gawin ang HTML version ng mga dokumento: Gumagamit ng Sphinx ang aplikasyon ng Parrot upang lumikhala sa paglikha ng HTML version. I-run nang ang:

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

    make help
    

I-push sa Web Server

Pagkatapos lumaki ang pagpapanalo sa dokumentasyon, makita mo ang mga talaksang HTML sa loob ng direktoryo build/html. Iyan ang mga talaksan na kailangan ikaw nang mag-upload sa iyong serbidor ng web.

I-edit ang .env upang makalikha ng URL ng server na gagamit ng rsync, halimbawa:

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

I-run ang sumusunod na command upang mag-rsync sa server:

./scripts/rsync-parrot-wtf

Ito ay magbabayaran ng lahat ng mga HTML files sa iyong pangunahing server.

Note

Ang pag-uugnay ng Parrot ay nasusulat sa Ingles at gamitin ang AI machine translation para sa ibang mga wika.