🩺 Vitals
- 🟢 Last active: 2026-08-31
- 📦 Latest release: 2026.08.26 (2026-08-26)
- 🐞 Open issues: 390
- 🌟 Stars: 8.4k
What do these metrics mean?
- Last active: when code was last pushed, as of our last check. The dot is green when that was recent, grey otherwise. A long gap can mean a tool is finished and stable, not only unmaintained.
- Latest release: the most recent tagged, packaged version the maintainers published. Not every healthy project tags releases.
- Open issues: unresolved reports and requests. A high number is normal for a popular project and is not a warning on its own.
- Stars: how many people bookmarked the project on its forge. A rough popularity signal, not a measure of quality.
🏗️ Profile
- Official: about.readthedocs.com
- Source: github.com/readthedocs/readthedocs.org
- License: MIT
- Deployment: Docker
- Data Model: PostgreSQL, Redis and Elasticsearch with Celery workers; builds run in sandboxed containers
- Jurisdiction: USA 🇺🇸 (Read the Docs, Inc.)
- Compliance (SaaS): N/A
- Compliance (Self-Hosted): Self-Hosted (User Managed)
- Complexity: High (4/5) - Django, PostgreSQL, Redis, Celery and Elasticsearch, plus sandboxed build workers
- Maintenance: High (4/5) - Multi-service stack and secure build sandboxing to keep running
- Enterprise Ready: Medium (3/5) - Proven platform, but self-hosting runs a heavy stack and must sandbox untrusted builds
1. The Executive Summary
What is it? Read the Docs is a documentation platform that automates the docs-as-code workflow. It connects to your Git repository, rebuilds your documentation on every commit using a generator such as Sphinx or MkDocs, and hosts the result with versioning, full-text search and pull-request previews. It is the platform layer that sits above the generators, and because it is MIT-licensed and self-hostable, an organisation can run the same automated docs pipeline that hosts documentation for thousands of open-source projects on infrastructure it controls.
The Strategic Verdict:
- 🟢 For teams that want an automated, self-hosted docs pipeline: Strong Buy. Versioned, searchable documentation built automatically from Git under a permissive MIT licence, on infrastructure you control rather than a metered hosted plan.
- 🔴 For small teams without DevOps and security capacity: Caution. Self-hosting runs a multi-service stack, and because it builds untrusted documentation code, it needs sandboxing to guard against container escapes. Most small teams use the hosted service for exactly this reason.
2. The "Hidden" Costs (TCO Analysis)
| Cost Component | GitBook (SaaS) | Read the Docs (Self-Hosted) |
|---|---|---|
| Licensing | Per-user subscription | None (MIT) |
| Data Custody | Vendor cloud | Your infrastructure and Git |
| Build & Hosting | Managed and metered by tier | Your infrastructure |
3. The "Day 2" Reality Check
🚀 Deployment & Operations
- Installation: A Docker Compose deployment of the platform stack: the Django application, PostgreSQL, Redis, Celery workers and Elasticsearch for search. This is a real multi-service system, not a single container.
- It builds untrusted code, so builds are sandboxed: Read the Docs runs documentation build code from user repositories, so build workers execute in sandboxed containers (Docker with gVisor). Hardening that sandbox against container escape is a genuine security responsibility that self-hosting places on you.
- It hosts generators, it does not replace them: You still choose a generator such as Sphinx or MkDocs to produce the documentation; Read the Docs provides the build, versioning, search and hosting platform around it.
🛡️ Security & Governance (Risk Assessment)
- Jurisdiction & Vendor: Read the Docs, Inc. is a US commercial entity, and the US CLOUD Act reaches its hosted service. The core platform is MIT-licensed with wide community reliance, and a self-hosted deployment keeps documentation on your own infrastructure and in your own Git, outside that reach. Governance rests with a single company, tempered by the permissive licence.
- The Compliance Shift and Untrusted Builds: Self-hosting shifts infrastructure security, patching and the build pipeline to you, and adds a burden most platforms do not carry: because it executes untrusted documentation code, the build sandbox must be maintained against container escape. No certification attaches to the open-source platform; securing and certifying the deployment is yours.
- No Licence Trap, Tiers Live in the Hosted Service: MIT carries no copyleft. The paid tiers (private repositories, single sign-on, analytics and custom domains) belong to the hosted readthedocs.com service, not to the self-hosted platform. Self-hosting the MIT codebase sidesteps those subscriptions in exchange for the operational and security burden above.
4. Market Landscape
🏢 Proprietary Incumbents
- GitBook: The polished SaaS documentation platform. Fast to start and low-maintenance, but per-user pricing and your content living on the vendor's cloud rather than your own Git and infrastructure.
- Netlify: The managed static-hosting platform teams often use to deploy generated docs. Convenient, but metered, and it places your build and hosting on a third-party service.
🤝 Open Source Ecosystem
- Docusaurus: The self-contained alternative. A generator that builds and deploys its own static site to any host, the lighter path when you want docs-as-code without operating a full hosting platform.
- Starlight: An Astro-based documentation generator that likewise produces a standalone static site, avoiding a hosting platform in favour of deploying the built output directly.