Vous avez lu la description de cette méthode de classe, mais vous ne comprenez toujours pas ce qui se passe. Si seulement vous pouviez lire rapidement le code source…
La puissance de Python ne réside pas seulement dans sa simplicité et son efficacité, mais également dans sa vaste communauté et sa riche documentation. Mais et si vous pouviez rendre cette documentation encore plus interactive et informative ? Aujourd'hui, je vais vous guider dans l'amélioration de votre documentation Python générée par Sphinx en la liant directement au code source correspondant sur GitHub.
Lorsque nous écrivons des docstrings appropriés dans notre code Python, nous jetons les bases de la génération d'une documentation API complète. Des outils comme celui de Sphinx autodoc et automodule sont parfaits pour extraire ces docstrings de nos modules, classes et fonctions. Mais ils ne parviennent généralement pas à fournir des liens directs vers le code source.
Si vous avez besoin de démarrer avec Sphinx, consultez ces didacticiels :
Pour ajouter cette fonctionnalité, nous devons d’abord modifier notre configuration Sphinx. Cela implique d'ajouter sphinx.ext.linkcode à notre liste d'extensions dans le conf.py fichier de notre source de documentation:
# docs/conf.py
extensions = (
...,
"sphinx.ext.linkcode",
)
...
Notre prochaine étape consiste à définir linkcode_resolve fonction. Cette fonction est chargée de déterminer l’URL que le…
