Read the Docs
文档构建与托管平台,连接 Git 仓库后按提交自动构建,支持 Sphinx、MkDocs 等框架,可保留多版本并为每个 pull request 生成预览,适合写文档的开发者跟着产品发布周期维护站点。
5 次可以打开平均 5.5 秒11 月 10 日 地址变更
本站从国内机房定期实测。竖条由远及近:绿 = 可以打开,橙 = 国内不可直接访问,灰 = 打不开。Read the Docs 是一个文档构建和托管平台。你把 Git 仓库连上去,它按仓库里的配置文件(.readthedocs.yaml)装好依赖、跑构建,把生成好的文档发布到网上。之后每次提交都会触发一次构建,文档跟着代码一起更新,不用自己搭 CI 或服务器。
主要功能
构建工具方面,它内置支持 Sphinx、MkDocs、Docusaurus 等常见文档框架,配置文件里可以指定 Python、Node.js 等工具版本和依赖清单。文档可以保留多个版本,从任意分支或标签自动构建,适合跟着产品发布周期走。
每个 pull request 会生成一份预览构建,并和线上版本做视觉对比,合并前就能看到渲染后的效果,而不是对着原始标记检查。平台还提供站内搜索、页面访问统计和搜索词统计,以及把旧地址重定向到新地址的功能。
面向 AI 工具,它支持 llms.txt、Markdown 内容协商和 agent skills,让文档能被各类 AI 工具读取。
社区版与商业版
平台分成两个站点。Read the Docs Community 面向免费和开源项目,克隆公开仓库、文档公开、托管带广告,对开源软件永久免费。Read the Docs Business 面向商业和非自由项目,可以克隆私有和公开仓库,文档可公开也可私有,带组织内的团队管理。商业版 Basic 每月 50 美元,Advanced 150 美元,Pro 250 美元,Enterprise 每年 1 万美元起,提供 30 天免费试用。私有仓库支持和单点登录属于商业版功能,SSO 可接 GitHub、GitLab,Pro 档还支持 Google。
适合谁
开源项目维护者可以零成本把文档挂上去,Flask、Jupyter、Godot 等项目都在用。有内部文档的商业团队则更适合商业版,用 SSO 控制谁能看到文档。注册可以用 GitHub 账号或邮箱,导入项目是一键选择已有仓库,之后补一份 YAML 配置即可。
