Rechercher

Recherche avancée
 
Accueil » Python » Forums Python » Forum général Python » Quelle générateur de documentation utilisez-vous ?

 • Quelle générateur de documentation utilisez-vous ?

Document Actions

Réponses: 3   Visites: 0
Up one level
Vous devez être un membre enregistré pour contribuer sur ce forum. Inscrivez-vous maintenant
Sujet précédent | Sujet suivant

 • Quelle générateur de documentation utilisez-vous ?

Posté par ychaouche le 23/07/2008 15:22
Je vais commencer à coder (après 2 mois de specs) et je me suis dit ça serait bien de choisir un générateur autoamtique de docs et de suivre les conventions nécessaires dans mes docstrings. Mais voilà, lequel choisir ?

Résultats actuels de ce sondage

Doxygen   0% (0)
epydoc   50% (1)
naturaldocs   0% (0)
pudge   0% (0)
apydia   0% (0)
autre (veuillez précisez)   50% (1)
Nombre total de votes: 2

Le sondage n'est pas scientifique et réflète seulement les opinions des utilisateurs qui décident d'y participer. Les résultats ne devraient pas être représentés comme l'opinion générale des utilisateurs, ni comme le public dans sa totalité.

 • Re: Quelle générateur de documentation utilisez-vous ?

Posté par ychaouche le 23/07/2008 15:37
Naturaldocs me parait bien : il arrive à detecter tout seul les pluriels. Si ma classe s'appelle Fruit et que j'écrive < Fruits > dans la doc, il mets un lien vers la class Fruit.

Plus fort, si ma classe s'appelle Child, < Children > est aussi détecté.

 • Re: Quelle générateur de documentation utilisez-vous ?

Posté par ychaouche le 23/07/2008 15:40
Ok c'est nul ça ne supporte pas python :)

 • Re: Quelle générateur de documentation utilisez-vous ?

Posté par encolpe le 23/07/2008 23:48
J'ai pas mal utilisé happydoc à une époque avant que epydoc ne se soit un peu généralisé dans la communauté Zope.
A mon avis il faut éviter d'utiliser un générateur de documentation qui impose un formatage trop stricte: cela déforme les docstring et cela pose problème lorsqu'il faut passer à un autre générateur.
_________________________
Encolpe DEGOUTE http://encolpe.degoute.free.fr/ Logiciels libres, hockey sur glace et autres activités cérébrales