Documentación Python

[Alberto Valverde]

Oscar (.teri) Triano wrote:
> El día 13 de abril de 2008 19:12, Jose <miracomovengo en gmail.com> escribió:
>
>   
>> Buenas tardes!
>>
>> Me gustaría saber qué programas utilizáis para generar documentación de
>> vuestro código fuente.
>>
>> Y por otro lado, tengo un montón de código que tiene comentarios debajo de
>> cada función del tipo:
>> """
>>        Extracts the contents of a gz file
>>
>>        @type  filepath: string
>>        @param filepath: path to gz file to be extracted
>>
>>        @return: the path to the file that has been extracted
>>
>>        @raise FileExtractorError: when the system is unable to open the
>> file or
>>        extract the contents
>>        """ <http://listas.aditel.org/faqpyes>
>>     
>
> También tienes Doxygen y muchos
> más.<http://es.wikipedia.org/wiki/Anexo:Comparativa_de_generadores_de_documentaci%C3%B3n>
>   

Echale un ojo también a Sphinx. Tiene muy buena pinta (por lo que he
podido ver al leer la documentación) y va a ser lo que van a utilizar
para la documentación oficial de python 2.6.

Un saludo,
Alberto
_______________________________________________
Lista de correo Python-es 
http://listas.aditel.org/listinfo/python-es
FAQ: http://listas.aditel.org/faqpyes