générer la doc d'un module

Version imprimable

30/08/2009, 15h31
airballman

générer la doc d'un module

Bonjour,

Je viens de finir de coder un logiciel en Python, et à l'intérieur du mode d'emploi je voudrais insérer la doc de mes modules.
Pour chaque fonction, j'ai inséré au cours du développement des commentaires, ainsi qu'en début de module.

J'ai bien essayé avec pydoc -w Main.py; mais la réponse obtenue est que mon module Main.py ne possède pas de documentation.

Quelqu'un pourrait il me donner une ou deux indications pour générer facilement une doc html ou autre de mon projet?

Merci d'avance
30/08/2009, 17h11
rambc

As-tu regardé du côté de Sphinx ? Il te permet de taper ta doc. avec les balises rst.

PS : si tu arrives à l'utiliser, je suis preneur. Je n'ai pas encore essayé car pour le moment je suis encore dans le cambouis de mon application.
30/08/2009, 17h12
airballman

oui j'ai déja regardé des trucs dans le genre,

mais ca m'a l'air bien complet pour un truc que je devrais pouvoir faire en deux trois lignes de codes...

Je vais essayer quand meme. Je serais tout de meme bien surpris que rien ne soit prevu de base par python dans ce sens poourtant....

Voici pour la doc des modules mais pour les fonctions, je ne sais pas trop

Code:

1
2
3
4
5
6
7
8
 
dico = globals().copy()
MODULE = type( dico.pop('__builtins__') )
 
for k, v in dico.items() :
    if type( v ) == MODULE :
        print( 'module :', k )
        print(  v.__doc__ )

30/08/2009, 20h30
oiffrig

Tu n'as pas bien lu l'aide de pydoc ;)
Ce que tu lui demandes là c'est de générer l'aide pour Main.py, en d'autres termes l'objet py (module, fonction, ...) du module Main.
Deux possibilités :
Donner le nom du module : pydoc -w Main
Donner le chemin : pydoc -w ./Main.py

Petite explication : s'il y a un / dans l'argument, pydoc considère que c'est le chemin du fichier, sinon c'est le nom de l'objet à documenter.
30/08/2009, 20h43
airballman

Merci a tous,

Tu avais raison oiffrig, a part que seule la deuxieme solution marche pour moi , la premiere me renvoie toujours la meme erreur...

De plus, j'obtiens apparement en faisant cette commande la doc de toutes els fonctions que j'ai pu utiliser durant le projet , ainsi que la liste des modules utilisés.

Par contre, aucune reference n'est ecrite concernant les docs que j'ai ecrite en cours de projet pour mes propres fonctions
(que j'ai ecrite de la forme)

def ex:
'''
doc ici
'''
suite de l algo

est ce possible ou ai je mal compris le principe de la doc?
30/08/2009, 21h01
airballman

Peut etre me suis-je mal debrouillé avec pydoc, mais jai trouvé epydoc qui utilise mes doc strings a merveille

il m'a suffit d'un epydoc --html Main -o Main our obtenir exactement ceque je voulais

Voila donc....

Merci tous de m'avoir aidé pour le post ;)
23/09/2011, 15h37
nancy maman

svp aidez moi

j'ai installé sphinx
mais en tapant la commande

Code:

make html

il me génère un fichier mais dans quelle étape je dois donner le chemin de mon rojet dont je veux générer la doc ?
car la commande

Code:

sphinx-quickstart

ne me permet pas de la faire :cry:
23/09/2011, 17h47
tyrtamos

Bonjour,

J'ai aussi pataugé dans pydoc et sphinx sans résultat satisfaisant.

Mais epydoc marche très bien!