Tutoriel : votre premier projet Sphinx¶
Dans ce tutoriel, vous construirez votre premier projet Sphinx, et le visualiserez dans votre navigateur au format HTML. Le projet inclura de la documentation manuscrite, sous forme narrative, ainsi que de la documentation d’API auto-générée.
Ce tutoriel est destiné aux nouveaux venus à Sphinx désireux d’apprendre les fondamentaux de la manière dont les projets sont créés et structurés. Vous créerez une bibliothèque logicielle imaginaire de génération aléatoire de recettes de cuisine, qui servira de fil conducteur au long du processus, avec comme objectif de la documenter correctement.
Pour exposer les capacités de Sphinx pour la documentation de code, vous utiliserez Python, qui supporte également la génération automatique de documentation.
Note
Plusieurs autres langages sont nativement supportés par Sphinx pour la génération manuelle de documentation du code, toutefois ils nécessitent des extensions pour la documentation automatique de code, comme Breathe.
Pour suivre le tutoriel vous aurez besoin d’avoir accès à une ligne de commande similaire à celle de Linux et d’une compréhension basique de son fonctionnement, ainsi que d’une installation fonctionnelle de Python pour le développement puisque vous utiliserez les environnements virtuels Python pour créer le projet.