Glossaire#
Information
Auteur : Philippe Dessus, Inspé & LaRAC, Univ. Grenoble Alpes.
Date de création : Juillet 2016.
Résumé : Ce document donne les principaux termes utilisés dans cette documentation.
- Un glossaire#
- Builder#
Un builder est un format de sortie-cible, généré par la commande
sphinx-build
oumake
. De très nombreux builder sont disponibles par défaut (epub, html, singlehtml) et d’autres peuvent également être ajoutés via des extensions (slides).- Projet Sphinx#
Un projet Sphinx est un ensemble de documents à propos d’un thème donné, réunis et ordonnancés par un fichier index.
- Directive#
Une directive est une extension du langage reStructuredText de base (voir syntaxe_rest), lui donnant de nouvelles fonctionnalités. Sphinx comprend un certain nombre de directives étendant ce langage. Une directive commence par “…” lorsqu’elle est utilisée comme un bloc ou est encadrée par des “:” lorsqu’utilisée dans le corps d’un paragraphe. Chaque directive peut comporter des arguments, des options, et un contenu.
- Role#
Un role est une directive qui agit sur un élément dans le texte.