Python: Documentación y Docstrings

Vamos a ver cómo generar documentación de Python.

En cualquier parte del código podemos poner triple comilla doble (conocido como Docstrings) y escribir como si fuese un comentario, sin embargo esos comentarios también sirven para documentar.
Luego podemos utilizar la función "help" para que nos muestre por consola la documentación que hemos escrito.

Un código de ejemplo:

def saludar(nombre):
    """ Función que saluda al parámetro que se le pase por parámetro """
    print("Hola " + nombre)

help(saludar)

Con eso mostraríamos la documentación.

También podemos mostrar la documentación por la consola de Windows utilizando el comando "pydoc" y el fichero .py que le indiquemos:

pydoc nombreFichero.py

También podemos hacer que nos imprima la documentación en un fichero HTML utilizando el comando:

pydoc -w nombreFichero.py

Y eso es todo.