Saltar a contenido
 No os perd谩is mi futuro contenido, seguidme en y Youtube 馃榿

Pydoc

En la lecci贸n anterior aprendimos que utilizando la funci贸n help podemos mostrar informaci贸n formateada por la consola. Pues en realidad esta funci贸n hace uso del m贸dulo pydoc para generar la documentaci贸n a partir de sus docstrings.

Desde la terminal no podemos utilizar la funci贸n help, pero s铆 existe la posibilidad de utilizar pydoc de forma similar.

Por ejemplo podemos consultar la documentaci贸n de scripts, m贸dulos y clases utilizando la sintaxis:

Note

pydoc nombre.py

Tambi茅n podemos utilizar la misma sintaxis para los paquetes:

Note

pydoc nombre_paquete

Documentaci贸n HTML

Una funci贸n interesante de Pydoc es que podemos generar la documentaci贸n de nuestro c贸digo utilizando la siguiente sintaxis:

Note

pydoc -w nombre.py

Si tenemos un paquete podemos generar toda la documentaci贸n de forma recursiva de la siguiente forma estando en el directorio del paquete:

Note

pydoc -w .\  # En MAC y Linux con la barra normal ./

O haciendo referencia al paquete:

Note

pydoc -w mi_paquete .\  # En MAC y Linux con la barra normal ./

Esto generar谩 toda la documentaci贸n del paquete, subpaquete, clases, m茅todos y funciones. Est谩 bien para publicarla en Internet, pero tambi茅n podemos consultarla directamente en local lanzando un servidor temporal, desde el directorio del paquete:

Note

pydoc -p 8000

Aunque esto mostrar谩 la documentaci贸n general de Python en ese momento, a parte de nuestro m贸dulo.


脷ltima edici贸n: 6 de Octubre de 2018