Construire la documentation

Ce document explique comment construire la documentation Sphinx pour l’application Parrot. Nous aborderons la mise en place d’un environnement virtuel (venv), l’installation de pip et l’utilisation de requirements.txt

Note

Parrot est en développement précoce, pas prêt pour les utilisateurs finaux.

Instructions d’installation

Clonez le dépôt: Tout d’abord, clonez le dépôt en utilisant cette commande :
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
Changer de répertoire dans le dépôt : Après le clonage, accédez au répertoire racine du projet en exécutant :
```
cd parrot-wtf
```

Installez python3-venv (apt) : C’est nécessaire pour créer un environnement virtuel. Exécutez cette commande :

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

Configurer un environnement virtuel (venv) : Accédez au répertoire racine de votre projet et exécutez :
```
python3 -m venv venv
```
« Activez l’environnement virtuel : » Avant d’installer des paquets, activez l’environnement virtuel en exécutant :
```
source venv/bin/activate
```
Utilisez requirements.txt : Ce fichier contient la liste des dépendances du projet. Pour les installer avec pip, exécutez:
```
pip install -r requirements.txt
```

Installer les sous-modules : Installez d’autres sous-modules de dépôt Parrot pour inclure leur documentation.

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

Construction de la documentation

« Nettoyer la construction existante : Si vous avez déjà construit la documentation, commencez par nettoyer les anciens fichiers de construction avec cette commande : »
```
make clean
```
Construire la version HTML de la documentation : L’application Parrot utilise Sphinx pour générer sa documentation. Pour créer la version HTML, exécutez :
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Envoyer vers le serveur Web

Après avoir construit la documentation, vous trouverez les fichiers HTML dans le répertoire « build/html ». Il s’agit de ces fichiers qui doivent être téléchargés sur votre serveur Web.

Modifiez .env pour définir l’URL du serveur à utiliser par rsync, par exemple :

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

Exécutez la commande suivante pour rsync sur le serveur :

./scripts/rsync-parrot-wtf

Ceci poussera tous les fichiers HTML dans build/html vers votre serveur principal.

Note

La documentation de Parrot est rédigée en anglais et utilise la traduction automatique par ordinateur pour les autres langues.