贴有标签的建筑商

加载项弹出菜单测试版

我们很高兴地宣布一个新的弹出菜单现在可用作为我们最新项目正在进行的beta测试的一部分,阅读文档加载项.

经过大量努力,我们很高兴能够开始用更多的项目测试此功能。我们之前一直在测试其他文档功能,但弹出式菜单是迄今为止最突出的功能。

阅读更多。。。


对默认项目依赖项的更改

此帖子于10月10日更新,以反映对已安装依赖项的所有更改

我们宣布不推荐自动安装几个关键项目依赖项,默认情况下,构建将不再安装较旧的文档工具版本。

阅读更多。。。


在配置文件中使用build.os而不是build.image

我们宣布内置图像支持的配置键内置.os.阅读文档将开始需要内置.os所有项目的配置键,以便成功生成文档。我们将于2023年10月16日开始对配置文件中未使用“build.os”的项目进行失败的构建.

我们知道这一变化将影响我们的许多用户,因此,我们有一个时间表来有效地向用户传达这种反对意见。

阅读更多。。。


删除对“使用系统包”的支持

阅读用于预安装常见科学Python包的文档,如松软的努皮熊猫马特普洛特利布和其他在系统级加快构建过程。然而,随着在Python生态系统中完成的所有工作以及“轮子”的引入,这些包很容易通过安装pip(点阵) 安装并且不再需要这些预先安装的软件包。如果您有Apt包依赖项,它们可以与一起安装构建.apt_packages.

随着我们新推出的“Ubuntu 20.04”和“Ubuntu22.04”Docker图像的推出,我们停止了预先安装这些额外的Python包,并鼓励用户使用要求.txt文件。我们已经停止在这些更新的映像上支持“使用系统包”。

阅读更多。。。


不推荐使用在其输出目录中没有index.html的生成

历史上,Read the Docs创建了一个自动生成的索引.html文件,其中包含有关如何在生成未输出此文件时正确设置项目的最基本说明。这个自动生成的文件使更多的用户感到困惑,而不是有所帮助,因为读取文档的行为与本地环境中的行为不同。

为了更好的机载用户,我们不赞成自动创建索引.htmlRead the Docs项目上的文件。我们现在将检查索引.html文件,如果没有问题,则以明确的问题信息失败索引.html文件位于输出目录的顶层。

阅读更多。。。


不推荐使用没有配置文件的Doctools(conf.py/mkdocs.yml)

历史性阅读文档创建了一个conf.py公司Sphinx项目和mkdocs.yml文件不提供MkDocs项目的文件,让入职变得更容易。这以不同的方式让我们的用户感到困惑8月28日,对于没有Sphinx/MkDocs默认配置文件的项目,我们将删除该文件的自动创建.为了避免意外行为或文档构建失败,您应该在此日期之前将配置文件添加到项目中。

默认配置文件的自动创建将在上完全删除8月28日。添加conf.py公司/mkdocs.yml文件以避免意外的生成失败。

阅读更多。。。


删除了对PyPy3的支持

从开始2023年7月18日PyPy3将被删除,作为在Read the Docs上构建文档的选项。

引入此功能是为了提高Sphinx的构建速度。然而,我们发现没有项目使用PyPy3构建文档我们决定取消对它的支持,以简化我们的产品并减少开发维护。

阅读更多。。。


Python新项目的“核心需求”将安装最新版本

从开始2023年8月7日“阅读文档”中导入的所有新项目将仅安装狮身人面像mkdocs公司阅读docs-sphinx-ext作为“核心需求”。默认行为是安装这些要求的最新版本。

请注意,之前的Read the Docs也在安装金贾狮身人面像rtd主题枕头嘲弄雪花石膏通用标记推荐标志根据不同的因素指定特定的版本,这些因素会让用户感到困惑,并且很难调试。

阅读更多。。。


将您的项目迁移到.readthedocs.yaml配置文件v2

我们将宣布一项新的所有构建都需要使用我们的配置文件版本2.本公告不推荐没有配置文件的构建,也不推荐配置文件的版本1。

阅读文档将开始需要.读取文档.yaml配置文件以成功构建文档。我们将停止支持没有明确配置的构建,因为这会创建用户不知道的隐式依赖关系。我们计划在2023年9月25日开始不使用配置文件版本2的失败构建.

阅读更多。。。


使用docutils 0.18生成错误

大约一周前开始,一些用户开始报告新的错误他们的项目构建。在大多数情况下,这些错误无处不在通常是相当神秘的错误引用狮身人面像文档实用程序.

那么,发生了什么?

阅读更多。。。


Ubuntu 20.04、Python 3.10以及对Node、Rust和Go的支持

我们很高兴地宣布,现在Read the Docs用户可以在其项目中使用较新的生成规范这会将基本图像更改为基于Ubuntu 20.04的图像,发布最新发布的Python 3.10,并允许用户轻松指定Node.js、Rust和Go的版本。这个特征已经酝酿了很长时间,我们认为这将简化许多项目的配置。

我们的构建者使用的Docker图像基于Ubuntu 18.04。最近,我们向添加了一个新功能安装自定义系统包这使得许多项目能够更好地控制其构建过程无需使用conda来管理非Python依赖项。

阅读更多。。。


安装自定义操作系统包(apt)

我们很高兴地宣布,现在Read the Docs用户可以在项目配置中声明自定义操作系统包它将安装在我们基于Ubuntu的构建器中,使用恰当的.这是一个期待已久的功能,我们认为这将简化许多项目的配置,尤其是科学方面。

我们的构建者使用的Ubuntu图像包含大量预装系统包装我们为所有项目发货使最常见的用例成为可能。这包括编译器、公共库的开发头以及其他。

阅读更多。。。


更好地支持科学项目文档

在过去的一年中,我们在使用康达.我们的构建服务器内存不足,项目构建失败。阅读文档时有这种内存限制,以避免误用平台,导致其他用户体验不佳。

我们的第一个解决方案是为此类项目提供专用服务器。我们将根据用户请求手动将它们分配给此服务器。这个变通方法还可以,但它对用户和我们每次都要手动执行一个步骤都会带来不好的体验。随着时间的推移,我们再次遇到了同样的OOM问题,甚至为一个项目提供了所有可用的内存来构建其文档。经过一些研究,我们发现这是康达社区的一个已知问题有一些不同的尝试来解决它(比如黑曼巴).不幸的是,它们都还没有成为标准,问题仍然存在。

阅读更多。。。