Nov 27, 2024

Wiki

Python

Aide

edit SideBar

Search

Documentation


La commande help

Dans un Python interactif, on peut obtenir de l'aide sur un module. Par exemple,

  >>> import random
  >>> help(random)

Pour avoir de l'aide sur un sous-module, par exemple stats dans scipy

  >>> import scipy.stats
  >>> help(scipy.stats)

Enfin, pour une fonction bien précise d'un (sous-)module :

  >>> import scipy.fftpack
  >>> help(scipy.fftpack.diff)

Dans ce qui précède, on demande l'aide sur la fonction fftpack du sous-module scipy.fftpack.

La documentation installée

Certains modules installent aussi de la documentation, ou des exemples, dans le répertoire /usr/share/doc

Les noms des répertoires contenant ces informations commencent généralement par python-.

Il peut être intéressant d'y jeter un coup d'oeil, après avoir installé un module.

Génération de documentation

On suppose qu'epydoc est installé.

Si l'on souhaite, par exemple, obternir la documentation du module os, alors on tape dans un terminal :

  $ epydoc --html os

Il se crée alors un répertoire html/, contenant un fichier index.html, que l'on peut ouvrir dans un navigateur : il s'agit de notre documentation (l'API de la bibliothèque).

On peut, à la place, générer du pdf :

  $ epydoc --pdf os

Le résultat est alors le fichier api.pdf du répertoire pdf/.

Il est possible de changer le répertoire de sortie d'epidoc, par l'option -o :

  $ epydoc --html os -o os

Page Actions

Recent Changes

Group & Page

Back Links