Cómo publicar la documentación de tu paquete de Python en línea#
Sugerimos que utilizas un servicio de hosting para la documentación de tu paquete de Python. Abajo encontrarás dos métodos gratuitos y comúnes para servir tu documentación en un sitio web.
Puedes servir tu documentación utilizando GitHub Pages u otro servicio de hosting.
Puedes servir tu documentación utilizando Read the Docs.
¿Qué es Read the Docs?#
Read the Docs es un servicio de hosting que permite publicar la documentación de tu proyecto.
Read the Docs es un servicio de hosting de documentación gratuito. Algunas de sus funcionalidades son:
Permite servir tu documentación de forma gratuita (pero hay opciones de pago si deseas personalizar el hosting)
Construye tu documentación automáticamente
Te permite integrar solicitudes de cambio para ver el progreso de construcción de la documentación (éxito vs error)
Permite versionar tu documentación, lo que permite a los usuarios acceder a versiones antiguas de la documentación en caso de que las estén usando en su paquete.
Permite descargar la documentación en PDF y otros formatos.
Puedes personalizar la construcción de la documentación usando un archivo .readthedocs.yaml en tu repositorio de GitHub.
¿Qué es GitHub Pages?#
GitHub Pages is a free web hosting service offered by GitHub. Using GitHub pages, you can build your documentation locally or using a Continuous Integration setup, and then push to a branch in your GitHub repository that is setup to run the GitHub Pages web build.
Read the Docs vs GitHub Pages#
GitHub Pages es una opción buena para el despliegue de tu documentación. Sin embargo, necesitarás hacer un poco más de trabajo para construir y desplegar tu documentación si utilizas GitHub Pages.
Read the Docs se puede configurar a través de tu cuenta de Read the Docs. El servicio automatiza el proceso de construcción y despliegue de tu documentación.
Si no deseas mantener un sitio web de documentación para tu paquete de Python, sugerimos utilizar Read the Docs.