Ajout_documentations.md

Sommaire

• Ecrire la documentation
• Pousser sur Github
• Déployer la documentation

Requirements

• Clé publique sur votre compte github (éviter d'entrer le password à chaque commit)
• Python 3
• pip3

sudo apt-get install python3 pip3

• Package mkdocs

pip install mkdocs

Ecrire la documentation

• Il faut écrire la documentation sur la branche master, dans le dossier docs.

Pousser sur Github

• Une fois la documentation écrite, il faut la pousser sur Github, branche master.

git pull
git add XXXX.md
git commit -m "ajout doc"
git push

• Attention il existe 2 branches : master et gh-deploy. Cette deuxième est utilisé par Github pages comme source pour le site web. Ne rien pousser sur cette branche => travail perdu au prochain deploiement !

Déployer la documentation sur le site.

• Sur la même branche master, executer la commande :

mkdocs gh-deploy

• Fini.