Discussion :

[augustus]

bonjour à tous,

je fais ma doc python sous pydoc avec linux. Ayant cherché sur le net une alternative à cet outil je me suis un peu cassé les dents sur des projets déléstés ou moins bien que pydoc. Est ce qu'il existe un outil de doc pour python qui ne renvoie pas des pages html un peu, comment dire ... moche et assez mal foutu?

PS : Ne me dites pas : tu peux mettre tes pages dans un ficher texte et faire ta propre mise en page, ... car je suis feniant et surtout pour la doc.

[Invité]

Salut,


Il me semble qu'il est possible d'utiliser Doxygen avec Python... Je crois que j'avais pris quelques notes là dessus, là je ne suis pas chez moi mais si tu peux attendre jusqu'à ce soir, je tacherai de te retrouver ça... Sinon en attendant va jeter un oeil sur le site de doxygen, ici

[frenchy404]

Pas des plus sexy mais je trouve Epydoc efficace:

http://epydoc.sourceforge.net/

[augustus]

merci pour vos réponses,

je vais commencé par essayer epydoc qui à l'air assez facile d'acces et qui est, frenchy, beaucoup plus sexy que pydoc (ca ressemble un peu à un mélange java doc et si vous connaissais à l'api de wxPython). Mais pierre si t'as proposition tient toujours je veux bien, Doxygen à l'air d'etre un outil portable et multi-langage ...

merci encore

[Invité]

merci pour vos réponses,

je vais commencé par essayer epydoc qui à l'air assez facile d'acces et qui est, frenchy, beaucoup plus sexy que pydoc (ca ressemble un peu à un mélange java doc et si vous connaissais à l'api de wxPython). Mais pierre si t'as proposition tient toujours je veux bien, Doxygen à l'air d'etre un outil portable et multi-langage ...

merci encore

Hello,

As-tu déjà utilisé doxygen ..? En fait, tout comme avec Pydoc, tu insères les éléments de documentation directement dans ton code. En revanche, c'est beaucoup plus puissant que Pydoc dans le sens ou tu peux utiliser des "tags" te permettant de donner des informations plus précises.

Pour Python, Doxygen peut se baser sur les chaines pydoc traditionnelles ou sur des blocs de documentation plus "Doxygenesques" ( ) : jette un oeil ici

Par exemple, tu pourras documenter un entête de fonction ainsi :

Code :

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

1
2
3
4
5
6
7
 
    ## Documentation de MaMethode
    #  @param param1 Description de param1
    #  @param param2 Description de param1
    #  @return Description de ce que retourne la fonction
    def MaMethode(param1, param2):
        pass

Ensuite, tu vas utiliser un fichier de conf. et lancer doxygen qui va alors générer tout seul ta doc aux formats que tu souhaites (rtf, html, man, ...). Il existe moult tags comme @param, @return, @brief...

Voili voilou, j'espère que ça t'a déjà aidé un peu

[augustus]

Voili voilou, j'espère que ça t'a déjà aidé un peu

Carrément merci d'avoir pris le temps de me repondre; Je vais tester tout ca je vais voir ce que ca donne mais c'est une présentation bien plus clair que pydoc en tout cas il y a pas de mal!