宣布用户定义的生成作业

我们很高兴宣布一项新功能,在Read the Docs上指定用户定义的构建作业。如果您的项目需要在生成过程中运行自定义命令,现在可以使用新的配置键执行它们构建作业.这为我们的用户打开了一个充满新的、令人兴奋的可能性的完整世界。

构建过程的背景

如果您的项目在构建过程中需要运行自定义命令,您可能希望能够轻松地指定这一点。你可能在狮身人面像内部使用了黑客解决方案conf.py公司文件,但这并不是解决这个问题的好办法。

该解决方案不受支持,它还有另一个重要的限制:它只运行命令从内部斯芬克斯的构建命令。克隆存储库后无法运行命令,或在启动Sphinx构建过程之前。添加了新的配置键构建作业,你可以做这些事情,甚至更多!

使用构建作业在配置文件中

阅读文档的构建过程定义明确并分为以下预定义作业:校验,系统依赖性,创建环境(_E),安装,建造上传.现在,随着构建作业,您可以使用之前和之后运行的自定义命令将其挂接。

假设您的项目需要立即运行命令之后克隆中的存储库校验工作。在这种情况下,您需要使用build.jobs.post_checkout(构建作业后检查)配置键:

版本以下为: 2
建造以下为:
  操作系统以下为: ubuntu-22.04号机组
  工具以下为:
    蟒蛇以下为: "3.10"
  工作以下为:
    检查后以下为:
      #取消对git存储库的隐藏
      #可以访问其完整的历史记录
      - git fetch—取消允许

在本例中,Read the Docs将运行吉特 克隆 ...作为第一个命令,然后运行吉特 取来 --不允许.然后,它将继续剩余的预定义作业。

要了解有关如何使用此新功能的更多信息,阅读生成自定义文档页面。

建筑商的未来

我们已经在讨论如何在未来扩展此功能。我们希望支持更复杂的构建过程,甚至不使用Sphinx或MkDocs的项目。这将为许多新的可能性打开大门。所以,订阅我们的邮件列表请继续关注!

现在就试试吧!

我们鼓励您现在就尝试一下,以增强文档的构建过程。正如我们所提到的,我们正在设计我们的建筑商的未来,我们正在收集用户的想法。您的反馈将使我们能够确保我们的设计足够灵活和可定制,我们支持尽可能多的用例。

请联系我们支持@阅读文档.通用域名格式让我们知道您是如何使用的构建作业