Sommaire

Consulter de la documentation avec pydoc3 Documenter:pydoc3

Tout d’abord, l’outil le plus courant qui permet de chercher dans la documentation des modules porte le nom de pydoc3. L’utilisation de pydoc3 intervient lorsque l’on souhaite afficher la documentation d’un module, d’une classe ou d’un mot-clé. Par exemple, la documentation de tous les mots-clés passés en revue dans les chapitres précédents (with, def, lambda, etc.) peut être consultée avec pydoc3. Point important à noter avant d’aller plus loin : la majorité de la documentation installée avec le système par défaut de Python est écrite dans la langue anglaise. 

Cet outil s’utilise exclusivement en ligne de commande. Ouvrez une console en cliquant sur Menu - Accessoires - LXTerminal, comme expliqué au chapitre Raspberry Pi 3, premier contact. Tapez ensuite la commande :

pi@raspberrypi:~ $ pydoc3

Ce qui devrait afficher le résultat suivant :

images/04RI01.png

Cela n’est rien d’autre que l’aide de pydoc3. Attention cependant car chaque version de Python installée sur le système est livrée avec sa propre version de pydoc. Comme expliqué au chapitre Raspberry Pi 3, premier contact, différentes versions de l’interpréteur Python doivent cohabiter sur le Raspberry Pi. Il en est de même pour pydoc qui est livré dans ses versions 2.7 et 3.4. Par défaut, le binaire pydoc pointe vers ...