Sphinx + Markdown : créer un site web

Par:
francoistonic

mer, 02/07/2025 - 07:36

Créer un site web avec Sphinx et Markdown ? Mike Driscoll relève le défi ! Sphinx est un puissant outil pour créer les documents techniques sur nos projets Python. ReStructuredText et Markdown. Il est possible de mixer les deux "univers".

Chaque page de la documentation ou d'un site web peut être écrit avec l'un ou l'autre ou les deux. 

1 / les dépendances

Il faut installer sphinx et myst-parser en utlisant venv pour disposer d'un environnement de développement virtuel. 

python -m venv NAME_OF_VENV_FOLDER

python -m pip install myst-parser sphinx

Puis, il faut installer sphinx via pip (pip3 si vous êtes sur Python 3). 

2 / création du site

Ensuite, nous créons un projet Sphinx qui fournira la structure du projet. On utilise sphinx-quickstart [nom du site]

Puis nous indiquons à notre projet Sphinx que nous allons utiliser markdown. C'est là que myst_parser joue son rôle. 

3 / Buildons !

Voilà notre projet, très simple, peut être buildé : sphinx-build -M html .\source\ .\build\

Les fichiers HTML sont créés automatiquement dans le dossier build/html. Bien entendu, vous pouvez étendre le contenu et les pages. 

Post source : https://www.blog.pythonlibrary.org/2025/07/01/creating-a-website-with-sphinx-and-markdown/