Discussion :

[rambc]

Bonjour,
je souhaite "documenter" mes projets et je pensais utiliser pythonDoc. Quelqu'un connaîtrait-il des exemples d'utilisation de pythonDoc ?
Je souhaiterais aussi personnaliser la mise en page (via HTML et CSS). Quelqu'un aurait-il des infos sur ce sujet.
Sinon existe-t-il d'autres moyens de documenter ses codes ?

[moumine]

Pour l'utlisation de pythonDoc il faut d'abord importer le module:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

import pydoc

Ensuite, il faut taper les docstrings (la documentation)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
def somme(a,b):
	"""Cette fonction additionne deux valeurs en l'occurrence a et b"""
	return a+b

Tous ce qui se trouve entre les triples guillemet c'est la documentation.

Pour afficher la documentation de ta fonction il te suffit simplement de taper:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

print somme.__doc__

Exemple de programme complet:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
import pydoc
 
def somme(a,b):
	"""Cette fonction additionne deux valeurs en l'occurrence a et b"""
	return a+b
 
print somme.__doc__

Il existe également la fonction "help" qui détaille votre fonction ou programme en intégrant votre documentation à l'explication.
(A écrire dans l'interpréteur)

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

help(somme)

Voila je t'ai expliquer en gros le fonctionnement du pydoc.
Sinon : http://www.grappa.univ-lille3.fr/~to...DocPython.html
Bonne journée

[rambc]

OK merci pour les infos.

Voici un lien vers une présentation bien faite de pyDoc : http://www.grappa.univ-lille3.fr/~to...DocPython.html .

Sinon je vais voir du côté de DOxygen et EpyDoc. Le 2nd a un bon rendu graphique.