Documentando python

Bueno, tras una pequeña investigacion sobre que herramientas hay disponibles para documentar python puedo afirmar que las dos finalistas son:

• epydoc
• pydoxy (o pydox, ¿cual usar?) (pythfilter + doxygen)

Desde luego epydoc por ser el mas especifico para python, es el mejor. Aparte de generar html, también genera pdf y latex.

De doxygen que se puede decir que no sepamos ya.... Es la caña de España. La única pega, es que no soporta directamente python. Es por ello que tenemos que usar un filtro que haga una traducción a un lenguaje que ya entienda. En este caso C++.

Pythfilter, traduce codigo python a stubs en C++. La unica pega que le he visto, con unas pruebas muy simples, es que no trata atributos en clases ni variables de ambito global. Con pruebas mas profundas podrían aparecer mas pegas.

La ventaja de pydoxy sobre epydoc, es que los diagramas de herencia son graficos, y proporciona además diagramas de colaboración y de relación entre modulos. El que sean gráficos tiene la ventaja de que pueden ser usados para generar documentación mas formal (ej. documentos de diseño).

Concluyendo:

• si no queremos complicarnos nada la vida, yo usaria epydoc, pero lo complementaria con doxygen para poder obtener diagramas graficos.
• en caso contrario, y disponemos del tiempo, mejoraría pythfilter y usaría epydox.
  

Para ver mas información sobre que herramientas hay disponibles, Gehard tiene un informe sobre python SCDUs. No incluye los enlaces pero con google se obtienen facilmente.

Sobre A9

Esta currado el buscador este. Sobre todo el tema del clustering y su presentacion.
Como sospechaba, usa por debajo google. Habra que probarlo cuando tenga que buscar algo, a ver que tal se porta... (por cierto, ya hace tiempo mi hermano me comentó sobre él).