Lire la documentation de modules et API de Python dans un navigateur

Un titre à rallonge, mais qui ne trompe pas, pour une petite astuce avec Python.

L’idée est de lire la documentation de tout modules dans un navigateur, le tout en locale. Plusieurs avantages à ça :

• Avoir toujours la documentation correspondante à la version installé
• Naviguer rapidement entre les modules tiers, installé par l’utilisateur

C’est une façon assez classique de procéder, qu’on retrouve dans certains langage. J’en écrivais un billet pour ruby de ce même procédé. On retrouve également pour Perl, Perldoc-server.

Cependant, je le trouve vraiment moins bien fait que celui de Ruby, qui a pour avantage d’être bien plus facilement navigable, la possibilité d’afficher le code correspondant (vraiment utile). Sans parler de l’esthétisme global bien meilleur.

Je trouve dommage que l’outil fournis par Python ne soit pas plus aboutis que ça, et si quelqu’un connais une alternative, permettant de consulter de cette façon la documentation des modules installés, je suis preneur.

Le fonctionnement est très simple, on lance le serveur comme suit :

Il vous suffit à présent de se rendre sur http://localhost:1337 Le choix du port est arbitraire, et presque pris au hasard dans l’exemple.