Read the Docs

平台介绍

Read the Docs是一个专业的文档构建与托管平台，旨在帮助开发团队将文档视为代码进行管理。自2010年起，已为Flask、Jupyter、Godot等数千个开源项目提供文档托管服务。平台支持从Git仓库同步代码，自动构建、版本化文档，并提供集成搜索、PR预览、权限控制等功能。

核心功能

• 支持多种文档工具：无缝集成Sphinx、MkDocs、Docusaurus等主流文档框架。
• 版本化文档：根据代码分支或标签自动构建并发布多个版本，匹配产品发布周期。
• PR预览：每次拉取请求都会生成实时预览构建，并显示与生产环境的可视化差异，在合并前发现文档回归问题。
• 权限控制：通过GitHub或GitLab SSO管理文档访问权限，支持公开或私有文档。
• AI集成支持：支持llms.txt、Markdown内容协商和代理技能，让文档兼容AI工具。

适用人群

适用于软件开发团队、技术写作者以及开源项目维护者。尤其适合希望将文档纳入CI/CD流程、需要管理多版本文档或对文档安全性有要求的组织。

使用方式

1. 注册账户（支持GitHub或邮箱注册）。
2. 导入Git仓库（支持公开或私有仓库，私有库需付费计划）。
3. 在项目根目录添加.readthedocs.yaml配置文件，指定构建环境、文档工具和依赖。
4. 每次提交代码后，平台自动构建并发布文档。

注意事项

• 开源项目可免费使用社区版，但托管文档需公开且包含广告。
• 商业和非自由项目需使用付费的Business计划，起价为每月50美元。
• 平台提供30天免费试用期，适用于商务计划。