<?xml version="1.0" encoding="utf-8" ?>
<rss version="2.0" xml:base="https://www.programmez.com/" xmlns:dc="http://purl.org/dc/elements/1.1/">
  <channel>
    <title>sphinx</title>
    <link>https://www.programmez.com/</link>
    <description></description>
    <language>fr</language>
    
    <item>
  <title>Documenter son projet avec Sphinx : session de la PyConFR 2025</title>
  <link>https://www.programmez.com/actualites/documenter-son-projet-avec-sphinx-session-de-la-pyconfr-2025-38481</link>
  <description>&lt;span class=&quot;field field--name-title field--type-string field--label-hidden&quot;&gt;Documenter son projet avec Sphinx : session de la PyConFR 2025&lt;/span&gt;
&lt;span class=&quot;field field--name-uid field--type-entity-reference field--label-hidden&quot;&gt;&lt;span&gt;francoistonic&lt;/span&gt;&lt;/span&gt;
&lt;span class=&quot;field field--name-created field--type-created field--label-hidden&quot;&gt;&lt;time datetime=&quot;2025-11-03T12:03:05+01:00&quot; title=&quot;Lundi, 3 novembre 2025 - 12:03&quot; class=&quot;datetime&quot;&gt;lun, 3 Nov 2025 - 12:03&lt;/time&gt;
&lt;/span&gt;


  &lt;div class=&quot;inline__links&quot;&gt;&lt;nav class=&quot;links inline nav links-inline&quot;&gt;&lt;span class=&quot;comment-forbidden nav-link&quot;&gt;&lt;a href=&quot;/user/login?destination=/actualites/documenter-son-projet-avec-sphinx-session-de-la-pyconfr-2025-38481%23comment-form&quot;&gt;Se connecter&lt;/a&gt; ou &lt;a href=&quot;/user/register?destination=/actualites/documenter-son-projet-avec-sphinx-session-de-la-pyconfr-2025-38481%23comment-form&quot;&gt;s&#039;inscrire&lt;/a&gt; pour publier un commentaire&lt;/span&gt;&lt;/nav&gt;
  &lt;/div&gt;

&lt;div class=&quot;btn btn-light&quot;&gt;
      &lt;a href=&quot;/actualites/outils&quot; hreflang=&quot;fr&quot;&gt;Outils&lt;/a&gt;
  &lt;/div&gt;

&lt;div class=&quot;mots-cles-actualite d-flex flex-wrap gap-2&quot;&gt;
      &lt;div class=&quot;btn&quot;&gt;&lt;a href=&quot;/actualites/sphinx&quot; hreflang=&quot;fr&quot;&gt;sphinx&lt;/a&gt;&lt;/div&gt;
  &lt;/div&gt;

            &lt;div class=&quot;clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item&quot;&gt;&lt;p&gt;Durant la conférence PyCon France 2025, Françoise Conil a présenté Sphinx. Sphinx est un des outils phares pour créer la documentation de son projet. La session s&#039;est focalisée naturellement sur Python. L&#039;un des avantages de Sphinx est sa souplesse : différent format de sortie, Markdown, reStructuredText, une communauté active. La 1ere version remonte à 2008.&lt;/p&gt;
&lt;p&gt;Son installation est simple : pip install sphinx. Françoise Conil conseille de l&#039;utiliser en environnement venv ou uv. Il faut tout d&#039;abord configurer et générer la structure documentaire (commande quickstart) puis séparer documentation et sources (--sep). La documentation est structurée : elle contient un fichier conf.py, un fichier racine puis le make/makefile pour générer la doc. Il est possible de créer une table des matières et les liens entre les documents : toctree. Il est possible d&#039;avoir plusieurs niveaux de profondeur.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;Naturellement, on peut intégrer à la documentation Sphinx, la documentation PyDoc.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;Voir la présentation (slides) :&amp;nbsp;&lt;a href=&quot;https://perso.liris.cnrs.fr/francoise.conil/documenter-avec-sphinx_pyconfr-2025/#/title-slide&quot;&gt;https://perso.liris.cnrs.fr/francoise.conil/documenter-avec-sphinx_pyconfr-2025/#/title-slide&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;Autre prise en main :&amp;nbsp;&lt;a href=&quot;https://blog.flozz.fr/2020/10/04/documenter-un-projet-python-avec-sphinx/&quot;&gt;https://blog.flozz.fr/2020/10/04/documenter-un-projet-python-avec-sphinx/&lt;/a&gt;&lt;/p&gt;
&lt;/div&gt;
      &lt;section class=&quot;field field--name-field-commentaire-actu field--type-comment field--label-above comment-wrapper&quot;&gt;
  
  

  
&lt;/section&gt;
</description>
  <pubDate>Mon, 03 Nov 2025 11:03:05 +0000</pubDate>
    <dc:creator>francoistonic</dc:creator>
    <guid isPermaLink="false">78220 at https://www.programmez.com</guid>
    </item>
<item>
  <title>Sphinx + Markdown : créer un site web</title>
  <link>https://www.programmez.com/actualites/sphinx-markdown-creer-un-site-web-37967</link>
  <description>&lt;span class=&quot;field field--name-title field--type-string field--label-hidden&quot;&gt;Sphinx + Markdown : créer un site web&lt;/span&gt;
&lt;span class=&quot;field field--name-uid field--type-entity-reference field--label-hidden&quot;&gt;&lt;span&gt;francoistonic&lt;/span&gt;&lt;/span&gt;
&lt;span class=&quot;field field--name-created field--type-created field--label-hidden&quot;&gt;&lt;time datetime=&quot;2025-07-02T07:36:47+02:00&quot; title=&quot;Mercredi, 2 juillet 2025 - 07:36&quot; class=&quot;datetime&quot;&gt;mer, 2 Jul 2025 - 07:36&lt;/time&gt;
&lt;/span&gt;


  &lt;div class=&quot;inline__links&quot;&gt;&lt;nav class=&quot;links inline nav links-inline&quot;&gt;&lt;span class=&quot;comment-forbidden nav-link&quot;&gt;&lt;a href=&quot;/user/login?destination=/actualites/sphinx-markdown-creer-un-site-web-37967%23comment-form&quot;&gt;Se connecter&lt;/a&gt; ou &lt;a href=&quot;/user/register?destination=/actualites/sphinx-markdown-creer-un-site-web-37967%23comment-form&quot;&gt;s&#039;inscrire&lt;/a&gt; pour publier un commentaire&lt;/span&gt;&lt;/nav&gt;
  &lt;/div&gt;

&lt;div class=&quot;btn btn-light&quot;&gt;
      &lt;a href=&quot;/actualites/outils/langages&quot; hreflang=&quot;fr&quot;&gt;Langages&lt;/a&gt;
  &lt;/div&gt;

&lt;div class=&quot;mots-cles-actualite d-flex flex-wrap gap-2&quot;&gt;
      &lt;div class=&quot;btn&quot;&gt;&lt;a href=&quot;/actualites/markdown&quot; hreflang=&quot;fr&quot;&gt;Markdown&lt;/a&gt;&lt;/div&gt;
      &lt;div class=&quot;btn&quot;&gt;&lt;a href=&quot;/actualites/sphinx&quot; hreflang=&quot;fr&quot;&gt;sphinx&lt;/a&gt;&lt;/div&gt;
  &lt;/div&gt;

            &lt;div class=&quot;clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item&quot;&gt;&lt;p&gt;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 &quot;univers&quot;.&lt;/p&gt;

&lt;p&gt;Chaque page de la documentation ou d&#039;un site web peut être écrit avec l&#039;un ou l&#039;autre ou les deux.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;1 / les dépendances&lt;/p&gt;
&lt;p&gt;Il faut installer sphinx et myst-parser en utlisant venv pour disposer d&#039;un environnement de développement virtuel.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;python -m venv NAME_OF_VENV_FOLDER&lt;/p&gt;
&lt;p&gt;python -m pip install myst-parser sphinx
&lt;/p&gt;&lt;p&gt;Puis, il faut installer sphinx via pip (pip3 si vous êtes sur Python 3).&amp;nbsp;&lt;/p&gt;
&lt;p&gt;2 / création du site&lt;/p&gt;
&lt;p&gt;Ensuite, nous créons un projet Sphinx qui fournira la structure du projet. On utilise sphinx-quickstart [nom du site]&lt;/p&gt;
&lt;p&gt;Puis nous indiquons à notre projet Sphinx que nous allons utiliser markdown. C&#039;est là que myst_parser joue son rôle.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;3 / Buildons !&lt;/p&gt;
&lt;p&gt;Voilà notre projet, très simple, peut être buildé : sphinx-build -M html&amp;nbsp;.\source\ .\build\&lt;/p&gt;
&lt;p&gt;Les fichiers HTML sont créés automatiquement dans le dossier build/html. Bien entendu, vous pouvez étendre le contenu et les pages.&amp;nbsp;&lt;/p&gt;
&lt;p&gt;Post source :&amp;nbsp;&lt;a href=&quot;https://www.blog.pythonlibrary.org/2025/07/01/creating-a-website-with-sphinx-and-markdown/&quot;&gt;https://www.blog.pythonlibrary.org/2025/07/01/creating-a-website-with-sphinx-and-markdown/&lt;/a&gt;&lt;/p&gt;
&lt;/div&gt;
      &lt;section class=&quot;field field--name-field-commentaire-actu field--type-comment field--label-above comment-wrapper&quot;&gt;
  
  

  
&lt;/section&gt;
</description>
  <pubDate>Wed, 02 Jul 2025 05:36:47 +0000</pubDate>
    <dc:creator>francoistonic</dc:creator>
    <guid isPermaLink="false">77808 at https://www.programmez.com</guid>
    </item>

  </channel>
</rss>
