Utiliser pydoc en Python

Manav Narula 22 janvier 2022
Utiliser pydoc en Python

Le module pydoc peut générer une documentation de style Python à partir de modules. Nous pouvons également visualiser cette documentation dans le navigateur, l’enregistrer en tant que page Web ou même la générer sur la console.

Pour afficher une liste de toutes les options possibles associées à pydoc et générer de la documentation, essayez la commande suivante dans l’invite de commande.

python -m pydoc

Cette commande retournera toutes les options possibles pour la documentation dans pydoc.

En utilisant -k, nous pouvons rechercher différents modules. Nous utilisons l’option -w pour écrire la documentation sous forme de fichier HTML dans le répertoire courant.

Pour rechercher des bibliothèques supplémentaires, nous utilisons l’option -k. Il existe diverses autres options disponibles.

Pour afficher la documentation de toute fonction, sujet ou module en Python, nous pouvons utiliser la commande suivante dans l’invite de commande.

python -m pydoc numpy

La commande ci-dessus affichera la documentation du module NumPy dans l’invite de commande.

Auteur: Manav Narula
Manav Narula avatar Manav Narula avatar

Manav is a IT Professional who has a lot of experience as a core developer in many live projects. He is an avid learner who enjoys learning new things and sharing his findings whenever possible.

LinkedIn