构建托管和共享文档-ReadtheDocs

自动部署技术文档 可以通过对文档源的每次更改来构建您的项目，使用现有的开发工作流来维护文档，每次推送更改时更新文档，在审核期间验证对文档的更改 在不管理额外服务的情况下维护您的文档。 构建、托管、CDN、身份验证和搜索都包括在内。

1.将文档作为代码进行维护

使用您已用于开发的所有相同工具和工作流管理软件文档。使用您最喜欢的编辑器编写文档， 使用版本控制提交更改，并在审核期间预览更改。

• 版本控制：为您的用户提供不会过时的文档。 从存储库中的提交、分支或标签构建多个版本。
• 地方化：与本地化工具集成，将您的文档翻译成多种语言。
• 跟踪更改历史记录：使用用于开发的同一版本控制系统来保留文档的更改历史记录。
• 自带工具：与 Sphinx、MkDocs 和 Jupyter Book 等工具集成， 并使用 Git 跟踪更改。 使用最适合您的项目的工具。

2.自动构建

每当在存储库中检测到更改时，都会重新构建文档， 因此，文档的每个版本始终是最新的。

无论您的项目是 Python 还是 Node.js，您的项目都可以控制 要安装哪些依赖项以及如何生成文档。

• 构建自定义:自定义文档构建以满足您的需求。安装自己的依赖项并运行自定义命令。
• 配置文件:设置项目并从存储库跟踪项目的配置。
• 离线格式：为您的文档输出 PDF 和 EPUB 格式，以便离线和跨设备查看。
• 连接到您的仓库：阅读文档与 GitHub、GitLab 和 Bitbucket 集成，可以从任何托管存储库克隆和构建文档。 您还可以手动连接到任何支持 Git 的存储库提供程序。

附加功能：

自动化规则 自动增加文档版本，并在新版本发布的基 础上重新构建。	重定向 通过为已移动或删除的页面添加重定向来 避免断开的链接。	通知 当项目生成遇到错误时接收电子邮件通知。
子项目 子项目可以共享搜索索引和自定义域，并 可以帮助对多个项目的集进行逻辑分组。	分析学 跟踪搜索 、查询和文档页面流量数据 ，无 需额外服务。	审核日志 跟踪和审查组织和所有私有文档项目的身份 验证尝试。
环境变量 使用环境变量为项目的生成命令提供机密。	Webhook 通过在每次生成后发送 webhook 事件，将 Read the Docs 连接到其他服务。	团队管理 控制组织内对项目的访问权限 ，并按团队对 项目进行分组。

1.预览更改

重新生成文档并预览每个拉取请求中的更改。 在发布文档更新之前轻松共享更改并帮助捕获错误。在 GitHub 和 GitLab 存储库上受支持。

2.一切都在一个地方

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

• 认证:付费计划功能通过集成的身份验证和共享令牌控制谁有权访问您的文档。
• 带上您的域名:将您自己的自定义域用于托管文档，并自动配置 SSL。
• 集成搜索:通过跨所有项目和版本的集成搜索，帮助用户找到需求。

1.自动化文档更新：

软件开发过程中，代码库经常更新，需要同步更新文档以反映最新的功能和修复。使用 ReadtheDocs API 自动触发文档构建过程，确保每次代码提交后文档都是最新的。

2.集成持续集成/持续部署流程：

在持续集成和持续部署的流程中，文档的生成和发布需要与代码的构建和部署同步进行。通过 ReadtheDocs API 与 CI/CD 工具集成，自动化文档的构建和发布过程。

3.多版本文档管理：

项目可能需要维护多个版本的文档，利用 ReadtheDocs API 管理不同版本的文档构建，确保每个版本都有对应的文档，并且可以轻松切换和访问。

4.自定义文档：

展示和品牌化企业或项目需要将文档集成到自己的网站或系统中，并进行品牌化定制。使用 ReadtheDocs API 获取文档内容，然后在自定义的界面展示，同时保持同步更新。