Costruire la documentazione

Questo documento spiega come costruire la documentazione Sphinx per l’applicazione Parrot. Copriremo l’impostazione di un ambiente virtuale (venv), l’installazione di pip e l

Nota

Il Parrot è in fase di sviluppo precoce, non è pronto per gli utenti finali.

Istruzioni di installazione

«Clona il repository: Prima, clona il repository utilizzando questo comando:»
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
«Cambia la directory nel repository: Dopo il cloning, vai nella directory radice del progetto eseguendo:»
```
cd parrot-wtf
```

Installa python3-venv (apt): Questo è necessario per creare un ambiente virtuale. Esegui questo comando:

sudo apt update
sudo apt install docutils gettext python3-pip python3-venv
# To build PDFs with LaTeX
sudo apt install texlive-full xindy

Imposta un ambiente virtuale (venv): Naviga nella cartella principale del tuo progetto ed esegui:
```
python3 -m venv venv
```
Attiva l’ambiente virtuale: Prima di installare qualsiasi pacchetto, attiva l’ambiente virtuale eseguendo:
```
source venv/bin/activate
```
Utilizza requirements.txt: Questo file contiene un elenco delle dipendenze del progetto. Per installarle utilizzando pip, esegui:
```
pip install -r requirements.txt
```

Installa i sottomoduli: Installa altri sottomoduli del repositorio di Parrot per includere la loro documentazione.

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

Costruzione della documentazione

Pulisci la build esistente: Se hai già compilato la documentazione, inizia pulendo i file della vecchia build con questo comando:
```
make clean
```
Compila la versione HTML della documentazione: L’applicazione Parrot utilizza Sphinx per generare la sua documentazione. Per creare la versione HTML, esegui:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Spedisci al server web

Dopo aver compilato la documentazione, troverai i file HTML nella cartella build/html. Questi sono i file che devono essere caricati sul tuo server web.

Modifica il file .env per impostare l’URL del server utilizzato da rsync, ad esempio:

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

Esegui il seguente comando per rsync sul server:

./scripts/rsync-parrot-wtf

Questo spingerà tutti i file HTML nella build/html sul tuo server principale.

Nota

La documentazione di Parrot è scritta in inglese e utilizza la traduzione automatica del computer per altre lingue.