Python para todos

Python para todos
lenguaje de marcado y EpyDoc para generar los documentos finales.
Epydoc se puede descargar desde su página web en forma de instalador
exe para Windows, paquete RPM para Fedora o similares, o en
archivos zip y tar.gz que incluyen scripts de instalación: http://epydoc.
sourceforge.net/. También se encuentra en los repositorios de varias
distribuciones Linux.
Una vez hayamos instalado Epydoc siguiendo el método adecuado
para nuestro sistema operativo tendremos acceso a su funcionalidad
a través de dos interfaces de usuario distintas: el script epydoc, que
consiste en una aplicación de línea de comandos, y el script epydocgui
(epydoc.pyw en Windows), que ofrece una interfaz gráfica. Además
también podemos acceder a la funcionalidad de epydoc programaticamente,
como en el caso de pydoc.
Vamos a crear un pequeño módulo con un par de clases para ver primero
el resultado de utilizar epydoc con docstrings de texto plano, sin
ningún tipo de marcado especial.
“””Modulo para ejemplificar el uso de epydoc.”””
class Persona:
“””Mi clase de ejemplo.”””
def __init__(self, nombre):
“””Inicializador de la clase Persona.”””
self.nombre = nombre
self.mostrar_nombre()
def mostrar_nombre(self):
“””Imprime el nombre de la persona”””
print “Esta es la persona %s” % self.nombre
class Empleado(Persona):
“””Subclase de Persona.”””
pass
if __name__ == “__main__”:
raul = Persona(“Raul”)
El formato de salida por defecto de epydoc es HTML. Por lo tanto
para generar la documentación en forma de documentos HTML bastaría
escribir algo así:
128