Pour réaliser ce TP, allez sur la branche 3_start_sphinx_doc

git stash
git checkout 3_start_sphinx_doc

Nouveauté sur cette branche :

L'objectif de ce TP est de créer une doc HTML avec Sphinx.

  1. Assurez-vous d'avoir installé les dépendances de dev : pip install -r requiments_test.txt
  2. Créez un dossier pour héberger la documentation : mkdir ./docs
  3. Allez dans ce dossier : cd docs
  4. Lancez le helper de sphinx : sphinx-quick-start
  5. Avec le formateur, complétez la configuration

En fonction du temps restant, explorez les possibilities offertes par Sphinx.

Les instructions du TP suivant sont ici