wikinotes

Outils pour utilisateurs

Outils du site

Piste : • variables_environnement • relation_one-to-many • relation_many-to-many
dev:python:frameworks:flask:integrer-documentation-sphinx-dans-application-flask

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
dev:python:frameworks:flask:integrer-documentation-sphinx-dans-application-flask [2025/09/20 13:47] – yoanndev:python:frameworks:flask:integrer-documentation-sphinx-dans-application-flask [2025/10/05 10:33] (Version actuelle) – yoann
Ligne 8: Ligne 8:
 [[dev:python:sphinx:introduction|Sphinx]] permet de générer de la documentation dans différents formats. Ici on souhaite produire de la documentation au format HTML et la servir via l'application Flask. [[dev:python:sphinx:introduction|Sphinx]] permet de générer de la documentation dans différents formats. Ici on souhaite produire de la documentation au format HTML et la servir via l'application Flask.
  
-Pour que Flask soit en mesure de servir les fichiers, on configurera Sphinx qu'il génère les fichiers de documentation dans un sous-répertoire du dossier ''./static'' de l'application Flask.+Pour que Flask soit en mesure de servir les fichiers, on configurera Sphinx pour qu'il génère les fichiers de documentation dans un sous-répertoire du dossier ''./static'' de l'application Flask.
  
  
Ligne 27: Ligne 27:
 Le script initialise l'arborescence nécessaire au bon fonctionnement de Sphinx notamment les dossiers ''source'' et ''build''. Le script initialise l'arborescence nécessaire au bon fonctionnement de Sphinx notamment les dossiers ''source'' et ''build''.
  
-Dans notre cas le dossier par défaut ./build ne sera pas utilisé, on le supprime :+Dans notre cas le dossier par défaut ''./build'' ne sera pas utilisé, on le supprime :
 <code bash> <code bash>
 rmdir build/ rmdir build/
Ligne 38: Ligne 38:
 </code> </code>
  
-Dans le fichier ''Makefile'' à la racine du projet, modifier la valeur des variables **SOURCEDIR** et **BUILDDIR** :+Dans le fichier ''Makefile'' à la racine du projet, modifier les valeurs des variables **SOURCEDIR** et **BUILDDIR** :
  
 <file> <file>
Ligne 46: Ligne 46:
 </file> </file>
  
-Générer la documentation depuis la racine du projet :+On peut maintenant générer la documentation depuis la racine du projet :
  
 <code bash> <code bash>
dev/python/frameworks/flask/integrer-documentation-sphinx-dans-application-flask.1758376037.txt.gz · Dernière modification : 2025/09/20 13:47 de yoann

Outils de la page

Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : GNU Free Documentation License 1.3
GNU Free Documentation License 1.3 Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki