Discussion :

[nancy maman]

Bonjour ,
J'ai mon programme développé sous python
J'aimerais générer une documentation en utilisant sphinx.
Quelqu'un sait comment ça marche ?
je signale que j'ai commenté mon code en ajoutant les balises """ commentaires"""

Existe t'il un cours Python pour ça ?

merci

[VinsS]

Bonjour,

Je suppose que tu as regardé ici:

http://sphinx.pocoo.org/tutorial.html

il y a aussi ceci:

http://scienceoss.com/use-sphinx-for-documentation/

Si tu parcours les docs créées avec Sphinx, tu verras qu'elles proposent de consulter les sources (ex. la doc Python dans le menu à gauche "Show source") ce qui te permet d'aborder la syntaxe nécessaire à la mise en forme.

Mais au départ, tu peux toujours faire un essai avec la commande

sphinx-quickstart

accepter les options par défaut et utiliser un simple fichier texte pour commencer.

Après il faudra que tu te mouilles avec le reStructuredText pour la mise en forme.

Il y a peut-être des éditeurs pour le reStructuredText mais sous Linux je n'ai rien trouvé de différent que mon bloc-notes. Sans avoir cherché longtemps, je dois dire.



edit: J'avais aussi ceci:
http://scienceoss.com/minimal-sphinx...ython-modules/

Pour bien apprendre Python suis ces tutoriels et cours Python : http://python.developpez.com/cours/
Le meilleur livre Python : Apprendre à programmer avec Python 3 par Gérard Swinnen http://python.developpez.com/cours/apprendre-python3/

[nancy maman]

j'ai regardé tous ces sources
mais mon problème ce que je ne vois pas là ou on doit renseigner le chemin de notre code source dont on veut générer la doc

j'ai installé sphinx
puis j'ai fais cette commande :

Code :

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

sphinx-quickstart

et apres cella :

Code :

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

make html

j'ai aussi rajouter ces lignes dans le fichier conf.py :

Code :

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

1
2
sys.path.append(os.path.abspath('_exts')) apres le import sys
extensions = ['configurationblock']

mais je n'arrive pas à trouvé la doc généré et c'est normal , car il doit me demandé quelque part de donner le chemin de mon projet source pour générer sa doc