# ---
# jupyter:
#   jupytext:
#     text_representation:
#       extension: .py
#       format_name: light
#       format_version: '1.5'
#       jupytext_version: 1.14.4
#   kernelspec:
#     display_name: Python [default]
#     language: python
#     name: python3
# ---

# # 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:
#
# ```bash
# pydoc nombre.py
# ```
#
# También podemos utilizar la misma sintaxis para los paquetes:
#
# ```bash
# pydoc nombre_paquete
# ```
#
# ## Documentación en HTML
#
# Una función interesante de Pydoc es que podemos generar la documentación de nuestro código utilizando la siguiente sintaxis:
#
# ```bash
# 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:
#
# ```bash
# pydoc -w .\
# ```
#
# 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:
#
# ```bash
# pydoc -p 8000
# ```
#
# Aunque esto mostrará la documentación general de Python en ese momento, a parte de nuestro módulo.

# Existen otras alternativas más bonitas para generar documentación, como los módulos **Epydoc** o **Sphinx**, pero al ser externos a Python no los trataremos en este curso.

StarcoderdataJupyterScriptsDedupFiltered