grimboite/articles/dev/python-pydoc-inclusion.md

Title	Tags
Générer de la documentation Python avec Pydoc	documentation, pydoc, python

Je cherchais un moyen simple d'afficher de la documentation dans un module d'administration Django, simplement pour égayer un peu l'interface d'admin (et aussi pour guider un peu l'utilisateur).

Par défaut, il existe le module pydoc qui permet d'utiliser la fonction help(), qui affiche toutes la documentation pour un objet (classe, méthode, propriété, etc.). On a aussi un objet html qui permet de parser correctement la documentation et d'y mettre plein de couleurs guillerettes.

Les outils de documentation inclus par défaut ou en modules dans Python: https://wiki.python.org/moin/DocumentationTools