Voici la documentation de l'équipe HRC.
Elle est générée sur GtiHub en page web à l'aide de Sphinx. Vers la documentation.
La documentation est écrite en ReStructuredText puis générée en HTML avec Sphinx.
sudo apt install python3-pip
python3 -m venv .venv
# pour activer l'environnement virtuel
source .venv/bin/activate # In Linux
.venv/Scripts/activate.bat # In Windows CMD
.venv/Scripts/Activate.ps1 # In Windows Powershell
pip3 install -r requirements.txt # pour installer les dépendances
deactivate # pour désactiver l'environnement virtuelDans le dossier racine de la documentation, exécutez la commande suivante :
make htmlPour voir la documentation, ouvrez le fichier _build/html/index.html dans votre navigateur.
Tip
Sur Linux, vous pouvez exécuter la commande ci-dessous pour compiler et ouvrir la documentation dans votre navigateur :
make html && xdg-open _build/html/index.html