Créer des MOOT Agiles avec Sphinx¶
- Formateur: Sébastien Jolivet et Philippe Dessus
- Etablissement: Espé-UJF, Univ. Grenoble Alpes
Propos de l’exposé¶
Expliquer l’utilisation de Sphinx et de ses extensions, et expliquer en quoi l’outil peut être utile à des fins de formation
L’existant¶
Il existe de nombreux logiciels de cours
Plates-formes d’EAD : Moodle, Blackboard, Chamilo, etc. Outils d’édition : Scénari
Les outils de plate-forme sont assez lourds à gérer, authentification, modularité réduite, nécessité de reprendre le cours d’une année à l’autre...
Scénari : plus souple, mais nécessitant des ressources.
Sphinx est un outil initialement conçu pour générer les docs. du langage Python, ses nombreuses extensions et possibilités le rendent intéressant d’utilisation dans des formations.
Les fonctionnalités¶
Codage du texte en reSt, nécessitant peu de ressources
Partage de docs collaboratives.
Lister les principales
Extensions PyTeX pour les réfs.
Séparation forte données/forme, ce qui rend très facile le changement de thème/look.
le conf.py permet d’avoir une config stable et réplicable entre projets et réadaptable selon les besoins;
Cycle de tâches d’un concepteur de cours dans Sphinx¶
Faire des cours implique produire des présentations (simplifiées) et des notes de cours (plus complètes) et oblige à gérer des formats de fichiers différents, donc perte de temps à gérer des versions et des formats. De plus, il est souvent nécessaire d’adapter ses cours selon les niveaux des étudiants auxquels on s’adresse. Enfin, il peut être intéressant de produire son cours sur différents formats (p. ex., PDF, HTML), voire de pouvoir les éditer collaborativement.
Ces différentes contraintes sont assez difficiles à concilier. En effet, il existe des outils de conception de cours de haut niveau (comme p. ex. Scenari), mais ils sont très fermés et les documents créés avec ce logiciel ne peuvent aisément être récupérés d’une autre manière. Les outils de plus bas niveau (traitements de texte), assez souvent, ne disposent pas de fonctionnalités de codage du contenu. Nous présentons ici quelques fonctionnalités intéressantes de Sphinx, un logiciel conçu initialement pour la documentation du langage Python.
SE CENTRER MOOC
Limites¶
Installation Windows délicate
Contextes d’utilisation¶
Doc. modulables, travail sur briques réutilisables au besoin (intégrer des diapos aux documents); Maintenance facilitée Système tout en un
Maths: interface avec LaTeX
Pour aller plus loin¶
http://pyvideo.org/video/1660/documenting-your-project-in-sphinx https://bitbucket.org/birkenfeld/sphinx-contrib