Une liste de ressources Sphinx#

Information

  • Auteurs : Philippe Dessus, Inspé & LaRAC, Univ. Grenoble Alpes, avec la participation de l’équipe Pôle numérique, Espé, Univ. Grenoble Alpes.

  • Date de création : Mai 2017.

  • Résumé : Ce document est une liste de ressources à propos de Sphinx, un outil de création de documentations.

Informations supplémentaires

  • Date de modification : 28 mars 2023.

  • Durée de lecture : 2 minutes.

  • Statut du document : En travaux.

  • Note : Ces ressources constituent l’un des kits de pérennisation du projet ANR-Idéfi ReFlexPro et a bénéficié de son financement. Il concerne plus précisément l’action A20 (WP 1) du projet, pilotée par Philippe Dessus, assisté d’Émilie Besse.

  • Citation : Pour citer ce document : Auteur·s (Date_de_création_ou_de_révision). Titre_du_document. Grenoble : Univ. Grenoble Alpes, Inspé, base de cours en sciences de l’éducation, accédé le date_d_accès, URL_du_document.

  • Licence : Document placé sous licence Creative Commons : BY-NC-SA.

Ressources sur Sphinx#

Généralités#

Les extensions#

Les thèmes#

Des tutoriels#

Ecrire une thèse#

Ressources sur reST#

Généralités#

Editeurs de texte reST#

Il existe assez peu d’éditeurs reST, mais comme la syntaxe reST est proche de la syntaxe Markdown, beaucoup plus répandue, il est possible d’utiliser un éditeur Markdown.

Editeurs de tableaux reST#

Les tableaux sous ReST sont difficiles à créer. Les outils ci-dessous permettent d’assister cette création.

Convertisseurs#

  • odt2sphinx est un utilitaire convertissant automatiquement les documents odt en rst.

  • pandoc

Hyeroglyph#

Hyeroglyph est une extension de Sphinx permettant de générer automatiquement des présentations à partir de documents sources en reST. Cela peut par exemple permettre d’ajouter, dans un document de cours destiné à être lu comme un manuel, une partie qui, en invoquant le builder slides, s’affichera en présentation. Le thème de la présentation n’est pas modifiable, mais il y a un assez grand nombre d’options.

Bibtex#

  • Bibtex est une extension de Sphinx permettant de générer des bibliographies respectant différents formats, selon la norme BibTeX. Le rôle :cite: signale une référence dans le texte et la directive ..bibliography:: affiche les références. Les références sont saisies dans un fichier séparé au format BibTeX.

Autres extensions liées à la gestion bibliographique * Sphinx Natbib

Editeurs de fichiers BibTeX#

La plupart des logiciels de gestion bibliographique permettent l’export en BibTeX.

Produire des documents PDF#

Google Analytics#

L’extension “Google Analytics” de Sphinx. S’installe aisément (préférer l’installation à partir du fichier tar.gz). Il suffit ensuite

  • d’ajouter la mention ‘sphinxcontrib.googleanalytics’ dans la liste des extensions du fichier conf.py,

  • d’ajouter une ligne supplémentaire dans le fichier conf.py : googleanalytics_id = ‘UA-123-123-123’ (à remplacer l’identifiant Google Analytics (GA) qui a été déclaré pour le ou les documents).

La compilation en html des documents insère automatiquement le code javascript GA dans tous les fichiers du site, ce qui permet leur traçage des visites.