"pydoc" --- Generador de documentación y Sistema de ayuda en línea
******************************************************************

**Código fuente:** Lib/pydoc.py

======================================================================

El módulo "pydoc" genera automáticamente documentación de módulos de
Python.  La documentación se puede presentar como páginas de texto en
la consola, servidos en un buscador web, o guardados en archivos HTML.

Para módulos, clases, funciones y métodos, la documentación mostrada
es derivada del *docstring* (i.e. el atributo "__doc__") del objeto, y
recursivamente de sus miembros que se puedan documentar.  Si no existe
el *docstring*, "pydoc" trata de obtener una descripción del bloque de
comentarios arriba de la definición de la clase, función o método en
el archivo fuente, o encima del módulo (véase
"inspect.getcomments()").

La función incorporada "help()" invoca el sistema de ayuda en línea en
el interpretador interactivo, que usa "pydoc" para generar su
documentación como texto en la consola.  La misma documentación del
texto se puede ver desde afuera del interpretador de python al
ejecutar **pydoc** como un script en la consola del sistema operativo.
Por ejemplo, ejecutando

   pydoc sys

en la entrada de la consola mostrará la documentación sobre el módulo
"sys", en un estilo similar a las páginas del manual que se muestran
por el comando **man** de Unix.  El argumento de **pydoc** puede ser
el nombre de una función, módulo, o paquete, o una referencia con
puntos (*dotted reference*) de una clase, método, o función dentro de
un módulo o módulo en un paquete.  Si el argumento de **pydoc** se
parece a una ruta (*path*) (es decir, que contiene el separador de
rutas para tu sistema operativo como una barra en Unix), y hace
referencia a un archivo fuente de Python existente, entonces se
produce la documentación para ese archivo.

Nota:

  Para encontrar los objetos y su documentación, "pydoc" importa el
  módulo o los módulos que serán documentados.  Por lo tanto,
  cualquier código a nivel de módulo va a ser ejecutado en esa
  ocasión.  Use "if __name__=='__main__':" como protección para sólo
  ejecutar código cuando un archivo es invocado como un script y no
  sólo importado.

Cuando se imprime la salida a la consola, **pydoc** intenta paginar la
salida para una lectura más fácil.  Si la variable de entorno "PAGER"
está puesta, **pydoc** usará su valor como el programa de paginación.

Especificar un bandera (*flag*) "-w" antes del argumento hará que la
documentación HTML sea escrita en un archivo de la carpeta actual, en
vez de mostrar el texto en la consola.

Especificar una bandera (*flag*) "-k" antes del argumento buscará las
líneas de la sinopsis de todos los módulos disponibles por la palabra
clave (*keyword*) dada como argumento, de nuevo en una manera similar
al comando **man** de Unix.  La sinopsis de un módulo es la primera
línea de su cadena de documentación.

Puedes usar **pydoc** para empezar un servidor HTTP en la máquina
local que va a servir la documentación para buscadores Web invitados.
**pydoc -p 1234** empezará un servidor HTTP en el puerto 1234,
permitiéndote buscar la documentación en "http://localhost:1234/" en
tu buscador de preferencia. Especificar "0" como el número de puerto
seleccionará un puerto arbitrario no usado.

**pydoc -n <hostname>** empezará el servidor escuchando al *hostname*
(nombre del servidor) dado.  Por defecto, el nombre del servidor es
'localhost' pero si quieres que se llegue al servidor desde otras
máquinas, quizás quieras cambiar el nombre por el cual el servidor
responde.  Durante el desarrollo esto es especialmente útil si quieres
correr *pydoc* desde dentro de un contenedor.

**pydoc -b** empezará un servidor y adicionalmente abrirá un buscador
web con una página del índice del módulo.  Cada página servida tiene
una barra de navegación arriba donde puedes obtener (*Get*) ayuda
sobre una sección individual, buscar (*Search*) todos los módulos con
una palabra clave y sus sinopsis, e ir a las páginas del índice del
módulo (*Module index*), temas (*Topics*), y palabras clave
(*Keywords*).

Cuando **pydoc** genera la documentación, se usa el entorno y ruta
actual para localizar los módulos.  Así, invocar **pydoc spam**
precisamente documenta la versión del módulo que tu obtendrías si
empezaras el interpretador de Python y escribieras "import spam".

Se asume que la documentación del módulos principales residen en
"https://docs.python.org/X.Y/library/" donde "X" y "Y" son la versión
mayor y menor de tu interpretador de Python.  Esto puede ser sobre-
escrito al poner a la variable de entorno "PYTHONDOCS" una URL
diferente o un directorio local conteniendo la páginas de referencia.

Distinto en la versión 3.2: Se añadió la opción "-b".

Distinto en la versión 3.3: La opción de la línea de comandos "-g" se
eliminó.

Distinto en la versión 3.4: "pydoc" ahora usa "inspect.signature()" en
vez de "inspect.getfullargspec()" para extraer la información
distintiva de los invocables (*callables*).

Distinto en la versión 3.7: Se añadió la opción "-n".
