Aller au contenu

Contributing Documentation

Pour ce projet, nous utilisons MKdocs pour la documentation. Voici quelques informations pour vous aider à contribuer à la documentation.

Prérequis

Nous vous recommandons d'installer l'environnement virtuel Python pour installer MKdocs.

Python 3.6 ou supérieur est requis pour l'installation de MKdocs.

Installation de l'environnement Python

Pour installation Python, ouvrez un terminal (PowerShell) pour installer le bucket :

scoop bucket add main

scoop install main/python

Pour plus informations, visitez le site https://scoop.sh/#/apps?q=python

Pour installation Python, ouvrez un terminal (PowerShell) pour installer le bucket :

choco install python

Pour plus informations, visitez le site https://community.chocolatey.org/packages/python

Pour installation Python, ouvrez un terminal

brew install python@3.12

Pour plus informations, visitez le site https://formulae.brew.sh/formula/python

Installation de l'environnement virtuel Python

Créer un environnement virtuel Python avec la commande suivante :

python3 -m venv venv

ENVironnement Virtuel

Pourquoi utiliser un environnement virtuel Python ? [https://docs.python.org/3/library/venv.html(https://docs.python.org/3/library/venv.html){:target="_blank"}

Activation de l'environnement virtuel

Pour activer l'environnement virtuel Python, ouvrez un terminal et tapez la commande suivante :

Ouvrez un terminal (PowerShell) :

_venv_\Scripts\Activate.ps1

Ouvrez un terminal (CMD) :

venv\Scripts\activate.bat

Ouvrez un terminal

source venv/bin/activate

Installation de MKdocs

Pour installer MKdocs, tapez la commande suivante : Cette commande va installer MKdocs et les dépendances nécessaires.

python -m pip install -r requirements.txt

Pour aller plus loin

Nous utilisons le thème "Material" pour la documentation.

Pour plus d'informations, visitez le site https://squidfunk.github.io/mkdocs-material/

Lancement de MKdocs

mkdocs serve

MKdocs va lancer un serveur local pour visualiser la documentation.

Ouvrez un navigateur et tapez l'adresse https://127.0.0.1:8000/edu-framework/

Une fois installé

Une fois installé, vous pouvez contribuer à la documentation en modifiant les fichiers Markdown dans le dossier "docs" du projet. N'oubliez pas de travailler sur la branche "main" pour vos modifications et de faire une pull request pour les valider.

Si vous avez fermé le terminal, n'oubliez pas d'activer l'environnement virtuel Python avant de lancer MKdocs.