发布于2023年

阅读文档时事通讯-2023年12月

我们已经发货了单版本项目允许在没有翻译的情况下对项目进行版本控制。基于Proxito重构工作,这是一个长期需要的特性,我们很高兴能够发布。

我们通过以下方式提高了webhook的安全性需要一个秘密为所有webhook配置。这将有助于防止恶意参与者触发构建和其他操作。

阅读更多。。。


引入对仅版本项目的支持

URL是文档的重要组成部分。用户可以从URL推断您的文档是否具有或支持多个版本或翻译。

到目前为止,“阅读文档”允许您以两种方式配置项目:

阅读更多。。。


对来自集成的传入webhook进行安全更新

集成中的Webhook(如GitHub)用于:

将新提交推送到存储库时触发生成。

阅读更多。。。


阅读Docs时事通讯-2023年11月

硬化工作仍在继续加载项,我们新的文档内JavaScript客户端,支持所有文档工具。我们正在寻找社区中的人来测试这一新功能,并将在不久的将来扩大访问范围。

Python 3.12版现在在生成中支持,并且是指定时使用的默认版本build.tools.python: 在配置文件中。

阅读更多。。。


语言代码现已规范化

以下语言代码现在规范化为小写,并使用破折号代替下划线作为分隔符:

nb_否现在是未知

阅读更多。。。


阅读Docs时事通讯-2023年9月

🚀我们开始测试一个新的弹出菜单作为文档插件beta测试的一部分。beta测试目前仅限于使用build.命令配置键。

🛣️ 我们仍在进行一些折旧。我们本月宣布了使用系统包安装,配置键build.image,安装Sphinx和MkDocs的固定版本.密切关注您的电子邮件,以获取任何弃用通知,因为我们将继续通知维护人员可能受到影响的项目。

阅读更多。。。


加载项弹出菜单测试版

我们很高兴地宣布一个新的弹出菜单现在可用作为我们最新项目正在进行的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文件。我们已经停止在这些更新的映像上支持“使用系统包”。

阅读更多。。。


阅读Docs时事通讯-2023年8月

🏝️ 几个团队成员这个月休假了,一切都进展顺利,这总是令人高兴的。

我们的git克隆代码经过重构,现在项目的构建速度应该快得多。您拥有的git分支和标记越多,构建速度就越快。

阅读更多。。。


不推荐使用在其输出目录中没有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主题,枕头,模拟,雪花石膏,通用标记推荐标志根据不同的因素指定特定的版本,这些因素会让用户感到困惑,并且很难调试。

阅读更多。。。


阅读文档时事通讯-2023年7月

🚀 我们提供了自定义项目和子项目URL路径的支持,允许您删除或自定义/项目/子项目上的路径。这目前通过支持请求启用,并且仅限于阅读商务文档的某些计划。

🛣️ 正在进行的折旧:我们正在进行一些旧功能的弃用。这里的目标是降低构建平台的复杂性,并允许用户通过内置工具build.命令而不是功能标志。密切关注您的电子邮件,以了解可能会影响您的项目的任何弃用通知。

阅读更多。。。


阅读Docs时事通讯-2023年6月

⚠️ A类.读取文档.yaml配置文件将是未来生成所必需的。在中阅读有关此更改的更多信息将项目迁移到.readthedocs.yaml配置文件v2.

访问项目的语言段而不指定版本,现在会重定向到默认版本。例如,/恩/重定向到/英语/最新/.

阅读更多。。。


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

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

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

阅读更多。。。


阅读Docs时事通讯-2023年5月

🚁El Proxito代理应用程序已被重写。El Proxito为所有托管在Read the Docs上的文档网站解析URL。新的重写提高了解析器的性能,并使添加计划的功能成为可能。

🔎️ …新El Proxito实施中可用的新功能之一,是一个改进的404页面(请参阅下面的屏幕截图)。新的404页面是上下文化的,为用户和项目所有者提供了更好的错误消息和提示。我们正在逐步推出新的El Proxito,同时监控其稳定性,用户只能在启用了新功能的项目上体验新功能。

阅读更多。。。


阅读文档时事通讯-2023年4月

📚在过去的6个月里,我们逐渐重构了用户文档,以与迪亚的斯框架.结果现在显示在上的导航侧栏和登录页的结构中文档.readthedocs.io.

📊我们所有的网站现在都使用貌似有理的用于分析。

阅读更多。。。


阅读文档网站迁移到about.readthedocs.com

阅读文档正在将我们的主要营销网站迁移到单个网站:https://about.readthedocs.com.新网站为用户提供了有关我们产品及其功能的更多信息,在一个合并的演示中,展示了之前在两个网站(Read the Docs Community(readthedocs.org)和Read the Documents for Business(readthedocs.com))之间划分的内容。新网站还将成为登录“阅读文档”帐户的用户的单一入口点。我们的两个网站有很多混乱,这一改变使你更清楚地知道你要去哪个网站。

重要的是,对于登录用户,我们将社区和商业网站分开。我们为开源提供免费托管的承诺没有改变,或者为业务客户分离基础架构。

阅读更多。。。


阅读文档时事通讯-2023年3月

我们在GitHub上通过了第10000次发布/拉入请求。而且这在很大程度上等于5039个问题4872个拉取请求现已注册。感谢整个社区通过代码、问题、建议……和文档共同构建此功能!

🌪️ 跟进:上个月引入并行上传工件后,构建时间迅速下降rclone(克隆).根据生成输出中的文件数,构建时间可能减少了几秒钟或几分钟。例如,一个大型项目编写文档已从7分钟降至3分钟以下。如果您想查看项目的更改,查看之前和之后的构建时间2月8日.

阅读更多。。。


阅读Docs时事通讯-2023年2月

以下是自以前的新闻稿:

🪄生成输出现在存储在一个众所周知的位置:_阅读文档/<格式>.这为生成和处理最终输出格式提供了许多新的、令人兴奋的可能性,我们将在即将发布的博客文章中揭示这一点。MkDocs的PDF加密文档只是我们准备好的两个演示。敬请期待!

阅读更多。。。


阅读Docs时事通讯-2023年1月

2023年快乐!

以下是自以前的新闻稿:

阅读更多。。。


狮身人面像6已经出局,有重要的突破性变化

此帖子的重要更新⬇️

狮身人面像rtd主题1.2.0已经发布,并支持狮身人面像6。

阅读更多。。。