Documentación técnica (código)

Al comienzo quise hacer mi documentación técnica con Doxygen, pero se me dificultó un poco encontrar información relacionada con Python (lenguaje que estoy utilizando para mi programa) y me decidí mejor por Epydoc, que es la documentación especialmente para Python. Es muy sencilla de utilizar, aquí los pasos que me llevaron a conseguirla:

Paso 1: Una vez generados los códigos de los diagramas de clases elaborados en uml, debemos tener instalado Epydoc. En el terminal escribimos: sudo apt-get install python-epydoc

Paso 2: Damos Enter y se instalará en nuestra computadora el Epydoc, es un poco pesado así que se tardará un tiempo. Ya que lo tenemos instalado nos situaremos en la carpeta donde tenemos nuestro código generado, y ya que estemos ahí, ejecutamos cada archivo de nuestras clases con "epydoc Jugador.py" es decir, primero "epydoc" ya que es nuestro programa para elaborar la documentación seguida de un espacio y el nombre de nuestro archivo con la extensión .py

Lo hacemos con todas las clases que se hayan generado en nuestro diagrama de clases y ya tendremos una carpeta llamada "html" y ahí se encuentra nuestra documentación.

Es todo por esta entrada, espero les haya servido a todos aquellos que les guste programar en Python tanto como a mí.

______________________________________________________-

_______________________________________________________________________


Nota: Se generaron más archivos con extensión .html pero consideré que estos fueron los más importantes, ya que son los principales de mis clases.

Fuentes: http://mundogeek.net/archivos/2008/07/07/documentacion-en-python/
http://epydoc.sourceforge.net/
http://preguntas.barrapunto.com/article.pl?sid=04/10/14/0914213