产品功能-阅读文档

自动化技术文档的部署通过对文档源进行每次更改来构建项目。在不管理额外服务的情况下维护文档。构建、托管、CDN、身份验证和搜索都包括在内。

通过阅读文档开始自动化文档。

使用所有相同的工具和工作流程您已经在使用进行开发。使用您喜爱的编辑器编写文档，使用版本控制提交更改，并在审阅期间预览更改。

为用户提供不会过时的文档。从存储库中的提交、分支或标记构建多个版本。

与本地化工具集成，以多种语言翻译文档。

使用与开发相同的版本控制系统来保留文档的更改历史记录。

与以下工具集成狮身人面像，Mk文档、和Jupyter书，并使用跟踪更改吉特.使用最适合您的项目的工具。

写入重新结构化文本具有狮身人面像
或者写降价具有狮身人面像和MyST（我的ST）
添加参考文档蟒蛇代码
用文档记录RESTful API开放应用程序接口工具
包括一个Jupyter笔记本在您的文档中

只要在存储库中检测到更改，就会重新生成文档，所以您的文档的每个版本都是总是最新的.

您的项目是否蟒蛇或节点.js，您的项目控件要安装哪些依赖项以及如何生成文档。

自定义文档构建以满足您的需要。安装您自己的依赖项并运行自定义命令。

设置项目并从存储库中跟踪项目的配置。

为文档输出PDF和EPUB格式，用于脱机和跨设备查看。

阅读与集成的文档github，GitLab公司、和比特桶并且可以从任何托管存储库克隆和构建文档。您还可以手动连接到任何支持吉特.

从GitHub、GitLab和Bitbucket上托管的私有存储库克隆，或使用提供的密钥手动连接其他提供程序。

重新生成您的文档并预览每个拉取请求中的更改。轻松共享更改并帮助在发送文档更新之前捕获错误。

支持于github和GitLab公司存储库。

了解更多信息

向用户和客户交付文档所需的一切已包含在您的项目中。您可以轻松部署多个版本包括从身份验证到跨项目的所有内容搜索，而不配置任何其他服务。

主机公众的用户文档

使用内部共享文档团队

使用授予访问权限共享令牌

通过集成的认证和共享令牌控制谁可以访问您的文档。

将您自己的自定义域用于托管文档，并自动配置SSL。

通过跨所有项目和版本的集成搜索，帮助用户找到所需内容。

使用Read the Docs自动化文档部署。

其他功能

自动增加文档版本，并在新版本版本上重建。

子项目可以共享搜索索引和自定义域，并且可以帮助对多个项目集进行逻辑分组。

使用环境变量为项目的生成命令提供秘密。

通过为已移动或删除的页面添加重定向来避免断开链接。

跟踪搜索查询和文档页面流量数据，无需其他服务。

通过在每次构建后发送webhook事件，将Read the Docs连接到其他服务。

当项目生成遇到错误时接收电子邮件通知。

跟踪和检查组织和所有私人文档项目的身份验证尝试。

控制对组织内项目的访问，并按团队对项目进行分组。

自动文档部署的工作原理

将文档维护为代码

版本控制

本地化

跟踪更改历史

带上你自己的工具

自动生成

生成自定义

配置文件

脱机格式

连接到所有存储库

专用存储库支持付费计划功能

预览您的更改

一切都在一个地方

对于每个项目类型

身份验证付费计划功能

带上您的域

集成搜索

自动化规则

子项目

环境变量

重定向

分析

Webhooks（网钩）

通知

审核日志付费计划功能

团队管理付费计划功能