Repolode
Enviar
readthedocs

readthedocs/readthedocs.org

Plataforma de código abierto que compila, versiona y aloja automáticamente documentación desde repositorios Git, con compatibilidad con Sphinx y MkDocs.

Ver en GitHubSitio web
Estrellas
8,406
Forks
3,717
Issues abiertos
383
Último commit
anteayer

¿Qué es?

Read the Docs aloja la documentación de proyectos y equipos de código abierto. Obtiene la documentación de repositorios Git, la compila con herramientas como Sphinx (reStructuredText) o MkDocs (Markdown) y publica el resultado en un sitio alojado.

Está diseñada en torno al flujo de trabajo «Docs as Code»: cada push al repositorio puede activar una nueva compilación, para que la documentación publicada se mantenga sincronizada con el código. También permite mantener y servir varias versiones de la documentación de un proyecto.

Este repositorio contiene el código fuente que hace funcionar el propio servicio readthedocs.org. Es un proyecto de Python, y el README enlaza a documentación aparte sobre cómo configurar y gestionar proyectos y cómo contribuir al código base.

Funciones clave

  • 01Obtiene directamente de repositorios Git las fuentes de la documentación.
  • 02Compila automáticamente proyectos de Sphinx y MkDocs con cada push.
  • 03Mantiene y sirve varias versiones de la documentación.
  • 04Aloja la documentación compilada en un sitio público o privado.

Casos de uso

  • Alojar la documentación pública de una API o biblioteca de un proyecto de código abierto.
  • Publicar documentación interna del equipo que se actualice con cada commit.
  • Servir documentación versionada para que los usuarios consulten la correspondiente a la versión que tienen instalada.

Inicio rápido

  1. 1

    Regístrate en Read the Docs con tu cuenta de GitHub

  2. 2

    Cuando GitHub te lo solicite, concede acceso a tus repositorios

  3. 3

    Inicia sesión, haz clic en «Añadir proyecto», selecciona tu repositorio y haz clic en «Continuar»

  4. 4

    Revisa los detalles del proyecto, haz clic en «Siguiente» y sube commits para que la documentación se actualice automáticamente

Antes de usarlo

  • El servicio alojado está diseñado para proyectos de documentación, y alojar por cuenta propia toda la plataforma requiere un esfuerzo considerable.
  • La base de código es una aplicación Django de gran tamaño con muchas dependencias, por lo que configurar el entorno de desarrollo local requiere bastante trabajo.

En colecciones

Generadores de sitios estáticos y herramientas de documentación

Temas

#documentation#sphinx#mkdocs#python#docs-as-code#hosting#docs#sphinx-doc

Preguntas frecuentes

¿Qué es readthedocs.org?
Plataforma de código abierto que compila, versiona y aloja automáticamente documentación desde repositorios Git, con compatibilidad con Sphinx y MkDocs. Read the Docs aloja la documentación de proyectos y equipos de código abierto. Obtiene la documentación de repositorios Git, la compila con herramientas como Sphinx (reStructuredText) o MkDocs (Markdown) y publica el resultado en un sitio alojado.
¿readthedocs.org es gratuito? ¿Qué licencia tiene?
readthedocs.org es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿readthedocs.org sigue mantenido?
Mantenimiento activo. El último commit de readthedocs.org fue el 6 nov 2026.
¿Para qué puedo usar readthedocs.org?
Alojar la documentación pública de una API o biblioteca de un proyecto de código abierto. Publicar documentación interna del equipo que se actualice con cada commit. Servir documentación versionada para que los usuarios consulten la correspondiente a la versión que tienen instalada.
¿Cómo se instala readthedocs.org?
Regístrate en Read the Docs con tu cuenta de GitHub Cuando GitHub te lo solicite, concede acceso a tus repositorios Inicia sesión, haz clic en «Añadir proyecto», selecciona tu repositorio y haz clic en «Continuar» Revisa los detalles del proyecto, haz clic en «Siguiente» y sube commits para que la documentación se actualice automáticamente
¿Dónde consigo readthedocs.org?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/readthedocs/readthedocs.org

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados