[pyar] Necesito Feedback para herramienta de Documentacion

Andres Riancho andres.riancho en gmail.com
Mar Nov 5 14:01:16 ART 2013


2013/11/5 Diego Sarmentero <diego.sarmentero en gmail.com>:
> Hola gente, hace un tiempo hice este proyecto motivado por algo que
> habia surgido en el PyCamp del 2012:
>
> https://github.com/diegosarmentero/documentor
>
> El tema es que desde que hice eso, medio que quedo ahi, y me gustaria
> saber por ahi de gente que haya usado mas este tipo de herramientas
> que cosas les parece que seria bueno mejorar/agregar.
>
> Por ejemplo: estaria bueno que al generar la doc te corriera los tests
> y te mostrara una pagina con el coverage que tiene actualmente el
> proyecto??

No creo que sea beneficioso, ya hay otras tools que hacen eso. Yo me
enfocaria en la funcionalidad principal de la tool.

> Que te liste archivos que no sean pep8 compatible?

Idem

> Mostrar alguna representacion grafica del proyecto tipo diagrama de
> clases/modulos?

+1

> etc etc
>
> Cualquier sugerencia es bienvenida.

Yo buscaria cuales son las funcionalidades que ofrecen otras tools
(doxygen?) e intentaría adaptarlas a python

Algo que quizás se me ocurre es poder utilizar markdown dentro de los
comentarios de documentacion del codigo, que luego sea rendereado a
HTML cuando generas la documentacion.

> Saludos
>
> --
> Diego Sarmentero
>
> Website: http://diegosarmentero.org
> Twitter: http://twitter.com/diegosarmentero
> _______________________________________________
> pyar mailing list pyar en python.org.ar
> http://listas.python.org.ar/listinfo/pyar
>
> PyAr - Python Argentina - Sitio web: http://www.python.org.ar/
>
> La lista de PyAr esta Hosteada en USLA - Usuarios de Software Libre de Argentina - http://www.usla.org.ar



-- 
Andrés Riancho
Project Leader at w3af - http://w3af.org/
Web Application Attack and Audit Framework
Twitter: @w3af
GPG: 0x93C344F3


More information about the pyar mailing list