Re: [Python-es] Documentar código con docstrings

El día 3 de noviembre de 2009 10:48, Cesar Ortiz
<[email protected]> escribió:
> Necesito formalizar como vamos a documentar las APIs.
> Como ya decía había usado epydoc. Pero como bien dices parece que ahora van
> mas los tiros hacia sphinx... Pero no lo veo tan claro como con epydoc, de
> ahí la pregunta...
>
> Por otro lado la última versión estable de epydoc es de Enero del 2008, lo
> cual da a pensar que el proyecto está un poco parado.

Efectivamente, parece que epydoc se encuentra algo parado, con
bastantes bugs sin resolver que fallan con python 2.6 o superior.

Yo tiraría con sphinx por ser la herramienta más usada ahora mismo en
python, además de empezar a ser soportada específicamente por algunos
frameworks (eg: django) para documentar sus aplicaciones. En caso de
necesitar de una herramienta multilenguaje, siempre puedes incorporar
la salida de doxygen a sphinx con breathe:

  http://github.com/michaeljones/breathe
  http://michaeljones.github.com/breathe/


PD: "How the Django documentation works":
http://docs.djangoproject.com/en/dev/internals/documentation/
_______________________________________________
Lista de correo Python-es 
http://listas.aditel.org/listinfo/python-es
FAQ: http://listas.aditel.org/faqpyes