Generar automáticamente documentos de Python con pydoc

Python viene junto con pydoc. Puede usar pydoc para generar automáticamente documentación para su módulo o paquete. Para esto, su módulo o paquete debe contener cadenas de documentación.

Puede ejecutar pydoc directamente desde la terminal. cd al directorio que contiene el módulo para el que desea generar automáticamente una documentación. Luego, ejecuta el siguiente comando.

python -m pydoc -w modulename

En este caso, el módulo es modulename.py. El comando anterior generará un archivo .html que contiene la documentación generada automáticamente.

Para un proyecto más grande, prefiero almacenar toda la documentación de todos los módulos en un directorio. Para esto, primero creo la documentación para cada módulo. Lo hago con el comando anterior.

A continuación, creo un directorio vacío con el siguiente comando

mkdir docs

En este caso el nuevo directorio se llama “docs”.

Por último, muevo todos los archivos .html generados automáticamente al directorio docs .

mv *.html docs
Close

Meta