Nous sommes en train de choisir un standard de documentation pour documenter
notre code python.
Pour l'instant tout est documenté via les docstring en utilisant des
conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous
souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont
couramment utilisées dans la communauté python
Je ne vais pas tarder à commencer à utiliser Epydoc. Par contre, j'hésite encore entre Epytext et Javadoc (pour le format des docstring).
@-salutations -- Michel Claveau
Sylvain Thenault
On Thu, 27 Jan 2005 18:53:45 +0100, Simon Alexandre wrote:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour documenter notre code python. Pour l'instant tout est documenté via les docstring en utilisant des conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont couramment utilisées dans la communauté python
Chez Logilab, nous commençons à utiliser epydoc dans nos projets depuis quelques mois. Personnellement je suis assez content de la clarté de la documentation dans le code source et du rendu html. Et j'ai l'impression qu'il est de plus en plus utilisé dans des projets python de plus ou moins grand taille (j'ai pas trop d'exemples comme ça en tête, à part twisted bien sur, epydoc étant développé par la même équipe).
Enfin pour notre part on utilise le backend ReStructured Text, vu qu'on utilise déja ce format pour écrire plein de documents, ça évite d'avoir à apprendre un autre format. Je suis devenu assez accro au ReST, j'écris quasi jamais plus de html, docbook ou autre et ça c'est vraiment du bonheur !
On Thu, 27 Jan 2005 18:53:45 +0100, Simon Alexandre wrote:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour
documenter notre code python.
Pour l'instant tout est documenté via les docstring en utilisant des
conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous
souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont
couramment utilisées dans la communauté python
Chez Logilab, nous commençons à utiliser epydoc dans nos projets depuis
quelques mois. Personnellement je suis assez content de la clarté de la
documentation dans le code source et du rendu html. Et j'ai l'impression
qu'il est de plus en plus utilisé dans des projets python de plus ou
moins grand taille (j'ai pas trop d'exemples comme ça en tête, à part
twisted bien sur, epydoc étant développé par la même équipe).
Enfin pour notre part on utilise le backend ReStructured Text, vu qu'on
utilise déja ce format pour écrire plein de documents, ça évite
d'avoir à apprendre un autre format. Je suis devenu assez accro au ReST,
j'écris quasi jamais plus de html, docbook ou autre et ça c'est vraiment
du bonheur !
On Thu, 27 Jan 2005 18:53:45 +0100, Simon Alexandre wrote:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour documenter notre code python. Pour l'instant tout est documenté via les docstring en utilisant des conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont couramment utilisées dans la communauté python
Chez Logilab, nous commençons à utiliser epydoc dans nos projets depuis quelques mois. Personnellement je suis assez content de la clarté de la documentation dans le code source et du rendu html. Et j'ai l'impression qu'il est de plus en plus utilisé dans des projets python de plus ou moins grand taille (j'ai pas trop d'exemples comme ça en tête, à part twisted bien sur, epydoc étant développé par la même équipe).
Enfin pour notre part on utilise le backend ReStructured Text, vu qu'on utilise déja ce format pour écrire plein de documents, ça évite d'avoir à apprendre un autre format. Je suis devenu assez accro au ReST, j'écris quasi jamais plus de html, docbook ou autre et ça c'est vraiment du bonheur !
Dans fr.comp.lang.python, Simon Alexandre écrivit:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour documenter notre code python. Pour l'instant tout est documenté via les docstring en utilisant des conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont couramment utilisées dans la communauté python
Nous l'utilisation pour CPS pour publier régulièrement l'API complète. Cela demande un peu de rigueur, mais c'est très profitable.
-- Encolpe DEGOUTE http://encolpe.degoute.free.fr/ Logiciels libres, hockey sur glace et autres activités cérébrales
Dans fr.comp.lang.python, Simon Alexandre écrivit:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour documenter
notre code python.
Pour l'instant tout est documenté via les docstring en utilisant des
conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous
souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont
couramment utilisées dans la communauté python
Nous l'utilisation pour CPS pour publier régulièrement l'API complète.
Cela demande un peu de rigueur, mais c'est très profitable.
--
Encolpe DEGOUTE
http://encolpe.degoute.free.fr/
Logiciels libres, hockey sur glace et autres activités cérébrales
Dans fr.comp.lang.python, Simon Alexandre écrivit:
Bonjour,
Nous sommes en train de choisir un standard de documentation pour documenter notre code python. Pour l'instant tout est documenté via les docstring en utilisant des conventions de notation comme p_parameterName ou r_ReturnType
Après avoir testé Epydoc dont l'output nous semble impeccable nous souhaiterions savoir si les conventions qu'il utilise (Epydoc Fields) sont couramment utilisées dans la communauté python
Nous l'utilisation pour CPS pour publier régulièrement l'API complète. Cela demande un peu de rigueur, mais c'est très profitable.
-- Encolpe DEGOUTE http://encolpe.degoute.free.fr/ Logiciels libres, hockey sur glace et autres activités cérébrales
Hervé Cauwelier
Encolpe DEGOUTE wrote:
Nous l'utilisation pour CPS pour publier régulièrement l'API complète. ^^^^^^^^^^^^^
Les trolls sont autorisés le samedi aussi ?
-- Hervé Cauwelier
Encolpe DEGOUTE wrote:
Nous l'utilisation pour CPS pour publier régulièrement l'API complète.
^^^^^^^^^^^^^
