Une introduction aux outils de documentation.

Pr´esentation
Outils de documentation
Outils compl´ementaires
Conclusion
Une introduction aux outils de documentation.
Pr´esentation et d´emonstrations des outils courants de documentation
et d’analyse de code.
Lilian Besson (nounou responsable : Vincent Le Gallic)
Cr@ns
ENS de Cachan
19/02/2013
Ces slides et les ressources utilis´ees pour les exemples sont disponibles en
lignes 1http://perso.crans.org/besson/publis/seminaire_crans/, et
sur la page du Wiki Cr@ns.
N’h´esitez pas `a me contacter : mailto:[email protected].
1. Sous licence GPLv3.
Lilian Besson S´eminaire technique - Cr@ns. 1/34

Plan
1Pr´esentation
`
A propos
Que signifie “documenter” du code ?
Pourquoi ?
2Outils de documentation
Pour OCaml :OCamlDoc
OCamlDoc : d´emonstration (1)
OCamlDoc : d´emonstration (2)
Pour Python :pyDoc et Sphinx
Python : exemple
pyDoc : d´emonstration
Sphinx : quickstart
Sphinx : pr´eliminaire
Sphinx : d´emonstration
3Outils compl´ementaires
Pour OCaml
Pour Python
D’autres outils
4Conclusion
Prochain s´eminaire
Questions ?
Surtout, n’h´esitez pas `a m’interrompre !

Pr´esentation
Outils de documentation
Outils compl´ementaires
Conclusion
`
A propos (1)
De quoi va-t-on parler ?
Diff´erents outils pour documenter du code :
1OCaml ;
2Python.
Et aussi . . .
Outils compl´ementaires d’analyse statique et d’aide au d´eveloppement.
Lilian Besson S´eminaire technique - Cr@ns. 3/34

Pr´esentation
Outils de documentation
Outils compl´ementaires
Conclusion
`
A propos (1)
De quoi va-t-on parler ?
Diff´erents outils pour documenter du code :
1OCaml ;
2Python.
Et aussi . . .
Outils compl´ementaires d’analyse statique et d’aide au d´eveloppement.
Lilian Besson S´eminaire technique - Cr@ns. 3/34

Pr´esentation
Outils de documentation
Outils compl´ementaires
Conclusion
`
A propos (1)
De quoi va-t-on parler ?
Diff´erents outils pour documenter du code :
1OCaml ;
2Python.
Et aussi . . .
Outils compl´ementaires d’analyse statique et d’aide au d´eveloppement.
Lilian Besson S´eminaire technique - Cr@ns. 3/34