核心功能
使用指南
- 1
访问 readthedocs.org，使用GitHub账号或邮箱完成注册登录
- 2
在控制台点击导入项目，选中已有的Git仓库并建立连接
- 3
在仓库根目录添加 .readthedocs.yaml，声明构建系统与依赖
- 4
确认文档框架配置路径，例如Sphinx的 docs/conf.py
- 5
提交代码触发首次构建，在构建日志中排查报错并修正
- 6
构建成功后获取文档访问地址，可在设置中绑定自定义域名
- 7
开启拉取请求预览，之后每个PR自动生成渲染对比链接
- 8
配置版本规则与SSO权限，限定不同读者的可访问范围
优势亮点
开源与社区项目可长期免费托管，含搜索、版本切换与稳定访问地址。
每个拉取请求生成在线预览与视觉差异对比，合并前即可发现渲染问题。
支持Sphinx、MkDocs、Docusaurus等工具，配置文件声明依赖即可构建。
付费方案支持私有仓库与SSO，可用GitHub或GitLab组织统一管理访问。
使用须知
定价: 采用免费与付费并行模式：Read the Docs Community 对开源和社区项目免费，含公开仓库克隆、公开文档与广告支持的托管；Read the Docs Business 面向商业项目，支持私有与公开仓库、公开和私有文档、组织团队管理，官网标注每月50美元起。具体额度与结算方式以官网定价页为准。建议开源项目先用社区版，涉及私有代码或权限分级时再评估商业版。
价格和授权政策可能变化，请以官网最新信息为准
访问第三方网站时，请注意以下事项:
- 谨慎提供个人账号、密码和支付信息
- 下载文件前确认来源安全，警惕诱导性广告
- 涉及版权素材使用时，请核实授权范围
- 如遇网站无法访问或内容异常，可反馈给我们
常见问题
深度了解
Read the Docs 是一个把文档当作代码来处理的构建与托管平台，网址为 readthedocs.org。用户连接Git仓库后，平台负责从源码构建、生成多个版本文档、发布到公开网址。自2010年运行至今，Flask、Jupyter、Godot、UC Berkeley相关科研项目都使用它托管文档，开源项目可永久免费使用社区版。
核心能力集中在构建自动化与版本控制。平台内置对Sphinx、MkDocs、Docusaurus的支持，通过 .readthedocs.yaml 声明操作系统、Python或Node版本及依赖清单，每次提交自动触发构建；文档可按分支或标签生成独立版本，读者在页面上切换v1.0、v2.3等版本查看对应说明。每个拉取请求还会生成预览构建，并与生产版本做视觉差异对比，让评审者查看渲染结果而不是原始标记。
使用场景上，开源维护者用它免费获得搜索、版本切换与稳定域名，把精力放回内容本身；商业团队用付费方案克隆私有仓库，配合SSO把文档权限收敛到GitHub或GitLab组织内，内部接口文档只对授权成员开放；技术写作者依赖预览功能，在合并前检查目录、代码块与交叉引用是否正常。
竞品方面，GitHub Pages适合静态站点但缺少版本化构建与预览对比；GitBook偏向在线协作编辑，与代码仓库的耦合较弱；自建Sphinx加持续集成可以完全自定义，但需要额外人力维护流水线与服务器。Read the Docs的价值在于把这层基础设施托管出去，用配置文件换取可复现的构建结果。
人群建议：开源项目维护者与个人开发者优先使用社区版，零成本获得托管与搜索；有私有仓库、权限分级或团队管理需求的企业选择商业版；已在用Sphinx或MkDocs的团队迁移成本低，补一份YAML配置即可接入。
用户评价
还没有评分
成为第一个评价 Read the Docs 的人
我的评分
随下方评论一并提交