{"id":1349,"date":"2025-10-13T09:27:27","date_gmt":"2025-10-13T07:27:27","guid":{"rendered":"https:\/\/elearningsamba.com\/index.php\/pdoc-la-documentation-python-sans-documentation\/"},"modified":"2025-10-13T09:27:27","modified_gmt":"2025-10-13T07:27:27","slug":"pdoc-la-documentation-python-sans-documentation","status":"publish","type":"page","link":"https:\/\/elearningsamba.com\/index.php\/pdoc-la-documentation-python-sans-documentation\/","title":{"rendered":"pdoc – La documentation Python sans documentation"},"content":{"rendered":"

Vous avez d\u00e9j\u00e0 pass\u00e9 plus de temps \u00e0 configurer Sphinx qu\u2019\u00e0 coder votre projet Python ? Bienvenue au club !<\/p>\n

Et oui, paradoxalement, parfois documenter son code devient plus compliqu\u00e9 que d\u2019\u00e9crire le code\u2026 Vous voulez juste afficher vos docstrings joliment, mais avant \u00e7a il faut vous taper 200 pages de doc, choisir parmi 47 th\u00e8mes, configurer des dizaines d\u2019extensions et comprendre la syntaxe reStructuredText. Breeeef, la flemme !<\/p>\n

Heureusement, il existe une alternative qui va vous r\u00e9concilier avec la documentation : pdoc<\/strong>.<\/p>\n

pdoc, c\u2019est un outil de documentation Python qui ne n\u00e9cessite pas de documentation. Vous tapez simple pdoc votre_module<\/code> et c\u2019est tout. Pas de fichier de config interminable, pas de choix existentiels entre diff\u00e9rents builders, pas de migration depuis votre version de Sphinx de 2018 qui refuse de compiler.<\/p>\n

\u00c7a g\u00e9n\u00e8re directement une belle doc \u00e0 partir de votre code existant !!<\/p>\n

Si vous avez d\u00e9j\u00e0 \u00e9crit des docstrings propres et utilis\u00e9 les type annotations de Python, vous avez d\u00e9j\u00e0 fait 100% du boulot car pdoc se contente de prendre ce qui existe et de l\u2019afficher \u00e9l\u00e9gamment. Pas de traduction, pas de r\u00e9\u00e9criture, pas de fichiers .rst<\/code> \u00e0 maintenir en parall\u00e8le de votre code.<\/p>\n

Votre code EST la documentation et \u00e7a c\u2019est beau !<\/p>\n

<\/p>\n

L\u2019outil comprend les docstrings au format numpydoc et Google-style, fait des liens automatiques entre les identifiants, respecte votre variable __all__<\/code> et g\u00e9n\u00e8re du HTML standalone que vous pouvez h\u00e9berger n\u2019importe o\u00f9. Il y a m\u00eame un serveur web int\u00e9gr\u00e9 avec live reload pour d\u00e9velopper votre doc en temps r\u00e9el.<\/p>\n

Pour mettre \u00e7a en place, faut installer pdoc avec<\/p>\n

pip install pdoc<\/code><\/p>\n

Puis vous lancez<\/p>\n

pdoc .\/votre_projet.py<\/code><\/p>\n

ou<\/p>\n

pdoc nom_de_votre_module<\/code><\/p>\n

Et c\u2019est tout !<\/p>\n

Bien s\u00fbr si vous bossez sur un gros projet avec des besoins sp\u00e9cifiques, des guides utilisateurs complexes, des dizaines de pages de tutoriels et une doc multilingue, Sphinx reste le roi, mais pour la grande majorit\u00e9 des projets Python, ceux qui ont juste besoin d\u2019une doc API claire et lisible, pdoc fait \u00e7a comme un chef, sans que vous ayez besoin d\u2019un doctorat en outil de documentation.<\/p>\n

Bref, si vous en avez marre de passer plus de temps sur votre documentation que sur votre code, pdoc m\u00e9rite le d\u00e9tour car documenter son code devrait \u00eatre aussi simple que de le coder, non ?<\/p>\n

Pour tester pdoc, direction \npdoc.dev<\/a> \nou directement \nle repo GitHub<\/a> \n.<\/p>\n","protected":false},"excerpt":{"rendered":"