make html

Pour que l’outil génère tous les fichiers html de votre site, il vous suffit de taper make html dans un terminal, ouvert dans le dossier /docs (contenant le fichier make.bat)

Tous les fichiers html générés se trouveront dans le dossier /docs/build/html/.

Pour voir la page d’accueil de votre site, il vous suffit d’y double-cliquer sur le fichier : index.html.

Note

Pour que tous les liens soient à jour, avant chaque make html, videz le dossier /docs/build/html/ (via make clean). Ce n’est pas nécessaire si c’est juste après avoir corrigé une faute dans le texte ou après avoir modifié sa présentation.

Apparence du site

Modifier un mot dans le fichier docs/source/config.py permet de changer totalement l’apparence du site. À la ligne 50, html_theme = 'classic' donnera l’apparence que vous observez sur ce site.

https://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes

Documenter manuellement