我们已经发货了重定向的新改进，使我们的重定向功能更加强大和灵活。

我们已发货更新的通知方法。目前用户体验没有太大的差异，但随着项目的推进，我们将能够为用户提供更多的上下文和控制。

随着文档的发展，内容被移动，页面被重命名，导致用户链接断开。重定向允许您将用户指向页面的新位置。

我们很高兴宣布对重定向功能的重大改进，使其更加灵活和强大。

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

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

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

到目前为止，Read the Docs允许您通过两种方式配置项目：

集成中的Webhook（如GitHub）用于：

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

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

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

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

nb_否现在是未知

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

✅️ 在不指定版本的情况下访问项目的语言段塞，现在会重定向到默认版本。例如，/英语/重定向到/英语/最新/.

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

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

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

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

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

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

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

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

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

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

以下是自以前的新闻稿:

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

2023年快乐！

以下是自以前的新闻稿:

此帖子的重要更新⬇

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

本新闻稿包含自我们宣布第四季度重点关注以前的新闻稿.

以下是我们团队的最新更新：

我们很高兴宣布一项新的贝塔允许用户执行以下操作的功能完全覆盖“读取文档”生成过程.我们之前讨论过执行自定义命令 中间读取文档构建过程。这种方法对于具有高度定制的构建过程的项目来说是不够的，或者那些想使用不同文档工具的人，比如鹈鹕，文档化和多库萨鲁斯以获取其文档。其中一些人根本无法使用我们的平台。直到现在！我们有好消息要告诉他们！

新的配置文件选项build.命令只允许项目执行确切地他们想要的命令。没有了。同样如此。这意味着阅读文档不会执行任何默认命令在幕后。您可以100%控制构建过程。

以下是自我们宣布第四季度重点关注以前的新闻稿.

我们团队的最新更新：

我们很高兴宣布我们主题的新版本发布，狮身人面像rtd主题.在这个版本中，我们重点关注了错误修复、向后兼容性以及为未来版本铺平道路。

从视觉上看，我们有几个小的调整，除非我们在这里提到，否则大多数人不会注意到😇1.1版本的目标是保持向后兼容性，这也适用于可视部分。

一些几个月前GitLab开始强制所有OAuth令牌的过期时间为两小时。

不幸的是这个坏了与我们的应用程序集成，因此您的OAuth令牌可能已过期。OAuth令牌用于与GitLab API交互，用于报告合并请求的状态、创建webhook和列出存储库。为了使“阅读文档”能够访问新的令牌，您需要重新连接GitLab帐户。您可以通过以下方式实现：

9月是令人兴奋的，因为我们团队的一些成员终于亲自聚会了。Manuel、Benjamin和Eric都参加了9月份的Djangocon Europe，并围绕文档进行了大量精彩的讨论。

此外，正如我们所提到的，在第四季度，我们将重点关注我们的核心平台功能。这意味着我们可以谈论的新功能更少，但在使用Read the Docs的整体体验上有了许多小的改进。

阅读文档可以让您以简单的方式更新文档，通过每次开发人员推送git存储库时触发一个新的构建。根据您的工作流程，可能会出现在短时间内进行多次推送的情况。这会导致一种情况，即您必须等待很长时间才能得到将立即被覆盖的构建。

为了避免等待执行这些构建，我们实现了一个新功能来取消这些无用的构建，只执行最新的构建。这大大改善了用户体验，也减少了资源成本和能源浪费。

阅读文档会生成大量数据。我们是最大的文档平台，每天都有成千上万的项目使用我们的产品来托管他们的文档。这些数据包括用户数量、，使用特定Docker映像构建，以及通过要求.txt文件。在我们存在的头10年里，我们没有系统地收集这些数据。

去年，随着我们产品和团队的增长，加上我们收到的CZI拨款，我们开始问自己一些用现有数据无法回答的问题。我们决定开始处理一个项目收集相关数据，回答人们如何使用我们服务的大量问题。

我们8月份的重点仍然是营销和社区推广。我们继续更好地了解客户如何看待我们的产品，和他们一起工作，好好使用它。

我们正在努力制定2022年第四季度的目标，看起来，它将继续专注于完善核心平台功能。我们有一个许多的功能，我们需要继续让它们更容易使用。

我们继续为增加一名团队成员而扩大产能感到兴奋。我们7月份的重点是大量营销和定位，试图更好地了解客户如何看待我们的产品，和他们一起工作，好好使用它。

我们还拥有12岁生日就在出版这份时事通讯之前。🎉

夏天来了，这意味着我们的整体发展有所放缓，因为团队需要一些服务良好的假期。话虽如此，我们仍然对我们的最近的雇佣以及我们正在进行的支持文档生态系统的工作。

我们2022年第三季度（7月至9月）的重点是改进我们的前端和营销页面。这包括一个新奇的营销网站，以及经过改进的仪表板UX，它将使许多功能更适合我们的用户。

我们很高兴欢迎本杰明·巴尔德·巴赫对我们的团队来说，现在以兼职承包商的身份加入。他是一名开发人员，曾在Django社区担任开源维护者和活动组织者。他之前也曾为阅读文档做出过贡献，这将是团队中一个出色的补充。

我们也很高兴看到人们使用我们的新build.jobs功能我们之前宣布的。有很多有趣的方法可以用它来调整构建过程，我们将继续关注人们如何使用它！

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

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

四月是阅读文档的又一个令人兴奋的月份。我们已经为我们的以产品为中心的应用程序开发人员职位发布，我们正在进行第二轮采访。预计在接下来的几个月里会听到更多关于新团队成员的消息。

我们在路线图中继续构建了一些功能和错误修复：

对于阅读文档来说，三月是一个富有成效的月份。我们已经完成了以产品为中心的应用程序开发人员职位发布，我们对此感到兴奋。我们计划在几个招聘板上分享这一点，并且正在寻找一个对开发我们的产品感到兴奋的人加入我们的团队。

我们在三月的路线图中继续构建了一些功能和错误修复：

2021年仍然是艰难的一年。话虽如此，阅读文档今年发生了很多好事。

我们在CZI拨款，将我们的团队从5人发展到8人，并继续发展我们的EthicalAds网络&阅读商务文档.这是又一个稳步增长的年份，我们希望这种情况持续到2022年。

二月份公司战线上很安静，没有什么可报告的。我们正在积极制定最新的工作描述，这将是一个以产品为中心的Python开发职位。如果你有兴趣，请让我们知道.

二月份，我们继续进行重构和内部更改。主要用户体验变化包括：

随着入侵乌克兰的消息迅速发展，我们觉得有必要向用户和客户提供更新。

在Read the Docs，我们对入侵乌克兰感到愤怒和悲伤我们谴责这种暴力行为是错误和非法的。我们正在监测欧洲的局势以及它与我们的员工、客户以及我们对开源世界的服务的关系。

去年，GitHub宣布出于安全原因，不赞成使用不安全的Git协议。此更改将于2022年3月15日永久生效。

在Read the Docs上，我们找到了大约900个使用Git协议URL的项目(git://github.com/user/project)克隆他们的项目。为了节省用户的时间，我们将其迁移为使用HTTPS克隆URL(https://github.com/user/project网站).

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

我们基本上已经完成了将Read the Docs for Business用户迁移到Cloudflare for SSL的工作。这将启用许多有趣的功能，所以请继续关注那里的更新。

在这篇文章中，我们传播了关于过去几周与狮身人面像生态系统最相关的消息，包括狮身人面像本身以及社区开发的扩展和主题。

狮身人面像4.4于1月17日发布，进行了多项更改，包括：

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将重点关注的内容。

我们现在正在使用Cloudflare SSL for SaaS为公司用户管理自定义域，这将消除我们需要的手工工作并使建立自定义域的过程几乎是瞬间完成的。它还将允许我们在未来提供更容易的CDN。

阅读文档致力于提高可访问性以及Sphinx自诞生以来的用户体验，并且包括文档所用的标记语言。多年前，在认真听取用户意见后，我们宣布了推荐标志帮助弥合降价的巨大流行拥有狮身人面像的强大能力。（现在不赞成使用MyST，请继续阅读以了解更多信息。）

毫无疑问，降价需求如此之大：这在很大程度上要归功于GitHub的巨大人气，标记是当今开源中使用最广泛的标记语言项目，领先于列表中的第二个reStructuredText一个数量级。

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

我们成功部署了针对垃圾邮件的缓解措施，我们很高兴地报告，滥用项目的数量已大幅减少。

我们非常高兴地宣布Read the Docs Embed API v3的可用性，连同其官方客户端sphinx-hoverxref1.0。这项工作之所以成为可能，部分是因为我们收到的CZI补助金.

正如我们在中写道的关于sphinx-hoverxref的第一篇博客文章，狮身人面像最强大的特征之一是否可以创建交叉引用其他文档项目。然而，一位读者在技术文档中找到了几个链接可能需要打开几个浏览器选项卡才能完全理解上下文，以语境转换的形式导致了很多摩擦。

我们很自豪地宣布，现在阅读文档支持Jupyter Book项目！

阅读文件和可执行的图书项目，朱庇特图书背后的人，分享对文档的共同热情，我们已经就各种主题合作了一段时间。例如，我们开始推广MyST，以支持我们的重新承诺今年4月，我们写了一本关于将Jupyter笔记本电脑与Sphinx配合使用这从他们的反馈中受益匪浅。

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

11月的第一周，我们参加了2021年基础开放源码软件科学年会，由CZI科学团队组织的活动。我们很高兴能与开放科学生态系统中的项目建立联系。

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

那么，发生了什么？

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

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

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

我们已恢复通过电子邮件发送博客更新。你可以订阅我们的时事通讯这样你就不会想念他们了。

欢迎阅读最新版本的每月通讯分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

我们已发布我们的狮身人面像主题1.0.0版的第一个候选版本，它增加了对Sphinx和docutils最新版本的支持，并宣布了我们未来的计划。查看链接的博客文章了解更多信息。更新：我们已经向PyPI发布了1.0

sphinx_rtd_theme的1.0.0版本于2021年9月13日发布。你可以使用以下组件安装最新版本：

或者，您可以使用以下命令升级安装的版本：

欢迎收看我们最新一期的月度通讯，我们分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将重点关注的内容。

我们有了一个新的团队成员！安娜作为前端开发人员加入我们在…的背景下我们获得的CZI拨款处理JavaScript文档嵌入客户端以及Read the Docs的重新设计和用户体验。

欢迎来到我们每月通讯的新版本，在那里我们分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

埃里克在2021年上游会议上介绍了该公司的历史以及开源可持续性的想法。您可以在中了解更多信息我们最近的博客帖子.

2021年上半年，Read the Docs的几个团队成员在播客和在线活动中谈到了该公司。如果你想了解更多关于我们公司的信息直接来自作为其核心部分的人员，听听我们对其他话题的想法比如开源可持续性和开发人员倡导，这篇博文是给你的。

埃里克是的特别嘉宾维持早在二月份，“关于长期维持开源的播客”。埃里克首先讲述了他如何安东尼共同创立了Read the Docs，谈到了编写文档社区，描述了启动的挑战伦理广告2020年，并讨论了利用道德广告资助开源项目的机会。

我们发布了0.6b1版狮身人面像悬停外部参照，Sphinx扩展显示内容预览交叉引用。

此扩展是一个重要部分我们正在做的改进文档互操作性的工作，尤其是科学文献，多亏了CZI拨款我们去年收到了。

欢迎收看我们月刊的新版本，我们公开分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

我们申请了下一轮CZI基础开源科学软件！我们的建议比前一个更雄心勃勃，我们对用户的可能性感到兴奋如果我们被录取。这笔资金将涵盖从2022年开始的两年工作。

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

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

欢迎来到我们每月通讯的新版本，在那里我们公开分享有关阅读文档的最相关更新，提供我们提供的新功能的摘要上个月，并分享我们在不久的将来将关注的内容。

团队不断壮大！Ra公司下周将加入我们为EthicalAds进行账户管理。

这是我们每月时事通讯的第一篇，我们想在其中与您公开分享“阅读文档”最相关的更新，提供我们向用户提供的新功能的摘要上个月，并分享我们在不久的将来将关注的事情。

我们有了一个新同事！胡安·路易斯将作为开发人员倡导者与我们合作，专注于实现的目标CZI拨款授予，改进面向公众的文档，并宣传我们的服务。

2020年对每个人来说都是艰难的一年，包括我们的团队。我们设法渡过了难关，并继续让5名全职员工为您更好地阅读文档。

我们将以一个新补助金，这需要我们做一些招聘.我们还推出了EthicalAds网络，这将我们的可持续发展方法带到了整个科技界。

我们很高兴地宣布API v3已达到稳定释放，现在，所有Read the Docs用户都可以使用。自从我们宣布API v3测试版，我们一直在根据用户反馈添加额外的功能和bug-fixing小问题。

新API v3不是API v2的完全替代品，但是我们强烈建议对所有新集成使用API v3.API v2将很快被弃用，尽管我们没有一个明确的折旧时间表。当我们这样做的时候，我们会提醒用户我们的计划。

更新：迁移成功，截至太平洋标准时间下午4点，站点已完全恢复。

我们想让您知道，在太平洋标准时间2月12日星期五下午1点（东部时间下午4点，UTC时间21点），阅读文档社区（readthedocs.org）将有一个仪表板计划停机时间约为4小时.

我们很兴奋地宣布Pull Request建筑现在，所有Read the Docs用户都可以使用。我们已经为此功能工作了一年多，让所有用户都能使用它是一个重要的里程碑。

此功能允许用户正确确认所有提交的文档构建，而不仅仅是那些合并到在“读取文档”上激活的分支中的分支。这将文档移动到您的持续集成管道中，并改进了文档工作人员的工作流程。

更新：此维护窗口已于太平洋标准时间下午5:40结束。

我们想让您知道，在太平洋标准时间2月5日星期五下午5:00（美国东部时间晚上8:00，周六01:00 UTC），阅读商务文档（readthedocs.com）将有一个计划停机约2小时.

阅读收到的文档支持科学软件的拨款今年年初。作为其中的一部分，我们正在招聘两个与赠款工作相关的新职位：

一个具有设计技能的前端开发人员

我们很兴奋地宣布阅读文档已收到Chan Zuckerberg Initiative的200000美元拨款科学基本开源（EOSS）程序。Read the Docs是世界上最大的开源文档托管平台。我们为许多科学软件包提供托管服务，包括一些过去曾获得EOSS资助的机构。你可以在官方公告.

我们的拨款分为两部分：

我们的上次广告更新现在是讨论我们的广告模式的最佳时机以及情况如何好转。

在我们的2019年统计发布，我们的广告收入与去年同期持平。从我们广告业务的结构来看，我们的收入主要随着流量的增加而增长Read the Docs已经足够成熟，其规模不会每年翻倍。

您可能已经注意到，我们的阅读文档社区网站在过去几周里变得更快了。速度有多快取决于你离弗吉尼亚州有多远，这是我们的服务器传统上居住的地方。

我们最近在上启用了CDN所有阅读文档社区网站，由慷慨赞助CloudFlare公司.这篇文章将更多地讨论我们是如何实现这一点的，以及为什么我们对此感到兴奋。

2019年是又一个好年景阅读文档.我们将继续有一个由5人组成的团队参与该项目，今年我们推出了许多新功能。

这是我们过去一年的统计数据，我们从2013年开始出版。这是我们努力在组织中保持透明的一部分，以及我们的源代码。

不久前，我们引入了一项新功能，帮助用户自动完成阅读文档的一些任务。自动化规则.

如果您使用多个版本管理项目，你可能已经注意到，阅读文档并不总是激活你的新版本1.如果您需要对新版本执行任何操作，您需要登录“阅读文档”帐户并手动登录。

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

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

最近，我们在技术文档的SEO目的是帮助文档作者和项目维护人员创建文档这样最终用户可以更容易地找到他们想要的东西。

在我提到我们的新指南后，一位开发人员直截了当地问我，“谷歌难道没有关闭网站用来排名更好的大多数漏洞吗？”。我以前听过一些技术专家的意见，所以我并不感到太惊讶。搜索引擎优化权威Moz.com，区分他们所说的黑帽SEO和白帽SEO区分这些“漏洞”和有助于SEO的更有用的网站改进。

在过去的几个月里，我们一直在努力改进我们的API。考虑到我们当前REST API v2的局限性，我们决定向前迈出更大的一步，创建一个新的API v3，将重点放在我们从现有用户那里听到的用例上。

与API v2相比，我们的新API v3有一些很大的不同，这使得它更加用户友好和有用。

为拉取请求构建文档是Read the Docs最需要的功能之一。类似于持续集成系统如何在每个pull请求上运行测试套件，此更改将为每个pull请求构建文档并将构建状态通知发送到提供者的状态API（例如Github状态API）。这将允许用户检查文档构建是否通过以及文档在合并到master之前的外观。

作为谷歌代码之夏（GSoC）2019的学生，我(马克苏杜尔·哈克)负责构建此功能。我项目的主要目标是，无论何时创建拉请求，都可以构建文档，并向提供商的状态API发送构建状态通知。

让用户能够轻松找到他们需要的信息对于阅读文档来说，一直以来都很重要。今年，我，瓦比哈夫·古普塔，抓住提供的机会由Google Summer of Code改进搜索。我的主要目标GSoC项目是：

制作一个狮身人面像延伸为用户提供“搜索-键入”体验。

在Read the Docs文档中，我们有一些操作指南帮助人们解决狮身人面像和阅读文档的具体问题。到目前为止，我们最受欢迎的指南正在播放向Sphinx添加自定义CSS和JavaScript.

在一些旧版本的狮身人面像中，这个过程更具挑战性从狮身人面像的文档中想出来怎么做也不容易。狮身人面像1.8确实简化了这个过程，特别是对于简单的情况。

2019年4月，Read The Docs团队刚刚完成了我们有史以来的第一次场外活动。我们第一次亲自聚会，并谈论了项目的未来。

图片会比我更好地显示这一点：

我们将我们的广告计划视为保持“阅读文档”本身可持续发展的一种方式，并用它来更好地支持社区。广告使我们能够让全职员工添加新功能并在我们的问题跟踪器中响应问题。我们还能够与开源社区共享数千美元通过我们的收入分享计划和拨款。

目前，大约30%的网站流量没有任何广告。2016年我们首次推出道德广告时，我们只在特定文档主题.我们故意慢慢做，以确保我们的广告看起来完整通过阅读文档，减少了对用户的干扰。

自我们首次推出以来已经三年了阅读文档上的广告虽然我们在我们的2018年统计数据，我们认为是时候对道德广告及其运作方式进行更新了。

我们的道德广告模式仍然很强大。我们证明了在广告之上建立商业模式是可能的无需求助于用户跟踪。与大多数其他广告支持网站不同，我们根据页面上下文显示广告，不是通过创建大量个人用户的行为简介。如果您正在浏览Python项目的文档，您可能会看到有关Pythons的相关广告。这很简单，很管用。

我们很高兴地宣布新版本的读取Docs配置文件（第2版）。

如果您是经常使用Read the Docs的用户，很可能您已经使用.读取文档.yml文件。

上个月，Read the Docs团队进行了30-40次客户开发访谈招聘经理和招聘人员从5人公司到科技界大牌公司。我们想了解更多关于不同公司招聘流程的信息以建筑为最终目标帮助公司寻找开发人员的产品.

上次，我们介绍了一些招聘经理小贴士根据公司告诉我们的情况。这次，我们一起求职者寻找下一份工作的技巧基于我们从招聘经理那里听到的见解。

刚刚开始使用Read the Docs的新项目现在将使用默认情况下为Python 3。虽然仍然可以将项目配置为使用Python 2.7与我们的配置文件，我们认为有助于推动Python生态系统采用Python3非常重要。

我们默认的Python版本目前是Python3.7。项目还可以选择使用默认构建映像的Python版本3.6和3.5。我们最终会但是，删除了对使用Python版本3.3和3.4构建项目的支持仍然可以选择支持任一版本的构建映像。

你是否曾为一个文档不完善的软件项目而苦苦挣扎过？如果一个有很好文档记录的项目，但在文档中找不到正确的部分，该怎么办？阅读文档核心团队已经意识到良好的文档搜索的重要性并让我以谷歌代码夏令营学生的身份接受挑战。我的GSoC项目的主要目标是重构搜索代码并升级后端搜索引擎，以及为我们的搜索功能添加更多功能，如精确匹配搜索，不区分大小写的搜索、键入时搜索、建议等。

谷歌代码之夏是一个全球性项目，学生们在该项目中与开源组织合作一个为期3个月的规划项目。阅读文档的核心团队提出了一些项目思路，其中一个是重构并改进搜索代码.我(萨夫万·拉赫曼)很想弄脏我的手弹性搜索并抓住机会申请因为这个项目，我被录取了。

在过去四周里，Read the Docs团队与工程招聘经理进行了数十次客户开发面试。我们想了解更多有关不同公司招聘流程的信息最终目标是构建一个产品来帮助公司找到开发人员。我们采访了在五人公司寻找人才的人，一直到科技界最知名的公司。在这篇文章中，我将介绍一些我们从招聘经理那里听到的常见信息和分享一些招聘经理改进公司流程的方法.在我们的本系列的下一篇文章，我会有一些可行的建议基于相同面试的求职者。

由于这是一篇很长的帖子，我想分享一些关键的收获：

在接下来的几周和几个月里，Read the Docs将转移一些项目从我们的传统传入webhook，到我们的项目级webhooks集成。

我们的遗留传入webhook是我们第一次尝试允许这样的提供商GitHub自动触发“阅读文档”项目的构建。这些webhooks缺少一些安全功能，因此，大约两年前，我们取而代之的是基于项目的webhook集成。我们添加了一个数字那时，webhook集成项目的特性，我们停止了新的来自使用旧的传入webhook的项目。

2018年是又一个好年景阅读文档.我们已经确定了一个对我们有效的可持续发展模式，并有一个由5人组成的团队全职参与该项目。

这是我们过去一年的统计数据，我们已经出版了6年了。这是我们努力在组织中保持透明的一部分，以及我们的源代码。

如果你正在招聘，阅读文档可能不是你首先想到的地方。然而，结束每月有700万独立开发人员使用Read the Docs来自世界各地。我们并没有打算建立一个更好的工作委员会，但在一些广告商使用我们的道德广告招聘方面，我们发现阅读文档是寻找开发人才的好地方。

开发人员并不总是积极找工作通过浏览求职板或公司职业页面。然而，他们正在阅读文档，阅读他们使用的库和框架。即使人们不积极寻找新工作，许多人乐于探索新的机会。

作为我们的一部分道德广告模型，阅读文档赠送10%的广告库存开放源码社区中的项目、会议和其他倡议。其中许多项目的运作方式与过去的Read the Docs一样，几乎没有收入。这些组织传统上没有资源使用付费广告。

我们为以下内容发布了广告：

阅读超过80000个开源项目的Docs宿主文档其中2500多个项目托管在各自的域中。文档托管于*.阅读文档.io多年来一直支持HTTPS，但我们最需要的功能之一是简化其他域上的HTTPS。今天我们很高兴地宣布阅读支持自定义域上HTTPS的文档!

今年早些时候，Cloudflare联系我们支持HTTPS用于自己领域中数千个开源文档项目。他们慷慨地为我们提供SaaS的SSL包装以缓解我们这边的整合。

我们想让您知道，8月18日星期六上午10:00 PDT（美国东部夏令时下午1:00，UTC 17:00），阅读文档将有一个计划停机约4小时.

为了确保系统的稳定性和性能，我们将在周末进行此升级这是我们使用量最低的时期。

最近，我们修改了Read the Docs的公共API。以前，我们的构建过程使用了最新的API（v2）但没有被外部用户大量使用。

作为这个过程的一部分，我们努力确保API易于使用访问“阅读文档”项目，生成、和版本，更容易按特定项目筛选生成和版本，而且那个文档是最新的。

今天，我们很高兴地宣布，Read the Docs荣获请勿跟踪（请勿打扰）。DNT是一种浏览器首选项，要求不跟踪用户在网上浏览时。

虽然对于DNT的确切含义还没有达成共识，我们正在关注电子前沿基金会（EFF）指导方针因为我们认为“请勿跟踪”可以提供良好的平衡在用户的隐私期望和经营企业的现实之间并保持阅读文档的可持续性。

您的电子邮件收件箱可能遭到轰炸在过去的几天和几周里，我们发布了“隐私政策更新”。这些电子邮件涉及一项称为《通用数据保护条例》（GDPR）的欧盟法律今天生效。

GDPR的目标是让用户重新控制他们的数据。这是尊重用户隐私的重要一步。收集尽可能多人数据的日子未经同意，并与任何愿意为此付费的人分享，这一切都结束了。

几周前，我们分享了广告屏蔽对我们的可持续性提出的挑战以及我们为此做了什么。5月4日，Read the Docs被添加到可接受广告列表也就是说，我们的访问者使用广告拦截器，选择允许非侵入性广告将再次看到我们的广告。这个对我们的广告浏览量、点击量和收入的影响是立竿见影的.

网络上对人口比例的估计各不相同运行广告拦截器，行业差异很大。我们在我们的上一篇文章.

今天我们宣布可以登录或注册阅读文档使用您最喜欢的版本控制托管服务，如GitHub、BitBucket或GitLab。这是我们最需要的功能之一这是我们长期以来一直想推出的产品。

对于新用户，注册过程大大简化。没有新密码需要记住，当您准备好开始构建文档时，阅读文档时，将准备好存储库列表，以便开始阅读。

上次，我们分享了道德广告作品以保持阅读文档的可持续性，而不会出现令人毛骨悚然的广告目标。这一次，我们将分享我们在广告方面面临的最大挑战之一。4月初，Read the Docs被添加到最受欢迎的广告阻止列表：轻松主义者.

添加到EasyList中产生了重大而直接的影响在阅读文档的底线。4月1日左右，32%的广告浏览量消失了.起初，我们认为我们做错了什么但后来我们发现，这完全是由于广告屏蔽。我们的实际交通量一点也没有下降。

自我们首次推出以来已经两年了阅读文档上的广告.我们认为是时候报告我们看到的结果了，并对一路上帮助我们的人表示感谢。

简单地说：

很久以前，我们写过已开始测试使用的新构建映像皮耶夫以支持Python的多个版本。直到最近，我们还选择性地选择项目来帮助测试新的图像，但在年初，我们添加了一个配置选项允许项目选择使用新图像，然后再将其设置为默认图像构建映像。

在不久的将来，此构建映像将成为默认的构建映像，但对于现在，您可以使用我们的手动选择您的项目YAML配置文件.

2017年是阅读文档的好年份。我们已经确定了一个对我们有效的可持续发展模式，并开始发展我们的团队，以便更好地支持社区。

这是我们过去一年的统计数据，我们已经出版了5年了。这是我们努力在组织中保持透明的一部分，以及我们的源代码。

去年，我们得到了一个MOSS奖致力于改进Python文档生态系统。我们宣布去年11月的首次部署，这是一篇关于整个项目进展情况的回顾性文章。

此工作现场http://www.pydoc.io网站/以及在GitHub上：

我们一直在运行我们的道德广告一年多以来，它开始在使阅读文档更具可持续性方面取得成功。

在这段时间里，我们只在Read the Docs主题项目上发布过广告。这样做的主要原因是确保我们的广告显示一致，不会对用户体验产生负面影响。我们正在努力建立一个尊重用户的可持续发展模式，确保事情设计合理、不引人注目是其中重要的一部分。

在又一次繁忙的PyCon会议之后，我们终于恢复了正常。见到老朋友并有机会结识新朋友总是很美好的来自社区的朋友。PyCon提供了一个很好的交流渠道我们的社区关注我们作为开放源码开发人员和开放源公司&比如资金、可持续性和建设社区。我们是看到PyCon离开波特兰很难过，但很幸运PyCascades公司很快就会填满留下的空隙卡斯卡迪亚在PyCon继续前进之后。

今年，我们宣布在“疾跑”期间正式推出“阅读文档”PyCon之后的一周。为了为了避免我们通常作为一个大投稿人在新投稿时遇到的问题项目。

昨天，我们推出了改进的项目webhook管理修正了我们升级到Sphinx 1.5的错误。

我们一直在慢慢升级我们的webhook管理页面。项目设置新的webhooks将看到我们配置的webhoke列表，包括我们在每个远程webhook中遇到的HTTP交换。

今天，我们很兴奋地宣布，我们的道德广告活动：Uniregistry公司。我们的道德广告计划的目标是为开源提供重要资金，并表明可以在道德上做到这一点——无需跟踪我们的用户，只提供来自相关合作伙伴的广告。

域名注册很早就被确定为我们项目的天然合作伙伴，因为它位于我们所有致力于构建互联网的必要基础设施的堆栈中。我们希望找到合适的合作伙伴，因为从历史上看，我们觉得域名注册公司的用户体验很糟糕。我们将介绍一些我们用来与Uniregistry合作得出结论的标准。

从本周开始，我们将为文档部署一个新的默认映像构建环境。此图像将更改默认的Python版本支持。

我们预计此次更改不会产生任何问题，但请务必提出有关的任何问题我们的问题跟踪器如果你注意到任何奇怪的行为。新的构建映像支持Python2.7和Python3.5，放弃对的支持蟒蛇3.4。如果您需要访问Python3.4，我们建议您注册以访问我们的下一个测试版图像。

恭喜，你度过了2016年！阅读文档一直在滚动，我们又度过了有趣的一年。

快速总结：

今天，我们很兴奋地宣布我们的最新项目：https://pydoc.io网址.这项工作是由MOSS拨款来自Mozilla。感谢Mozilla为我们的时间提供资金来构建这个精彩的社区资源。

运行阅读文档，我们一直为Python社区拥有的文档工具感到骄傲。我们将散文优先于API文档列表，并且在我们的项目中通常有高标准的文档。

我们很兴奋地宣布我们的第一个合作伙伴道德广告活动：哨兵.

Sentry是天生的第一合伙人，都是因为他们有悠久的历史支持和贡献开源社区，因为他们还努力支持开源，同时围绕他们的项目。

从今天开始，Read the Docs将开始在上托管子域中的项目域阅读文档.io，而不是打开阅读docs.org.此更改解决了托管用户时站点cookie的一些安全问题在与仪表板相同的域中生成数据。

针对更广泛的威胁提供安全保护的变化已经到位然而，仍有一些场景只能由迁移到单独的域。

周一，我们在readthedocs.org上的文档页面上启用了一个广告空间。我们在过去测试过广告空间，并在后续行动中讨论其含义广告。该空间对于文档页面的浏览和使用是完全不引人注目的，并且不支持第三方以任何方式跟踪用户。这一切都是为了帮助筹集资金，以支持项目的持续支持和维护，并确保免费开放的文档始终可用。

阅读文档是一种大规模项目，并且需要大量工作来保持运行和支持。我们收到支持请求，必须每天关注服务器的操作。这些任务都不利于志愿者的贡献，对于如此大的站点，它们都需要专门的支持角色。我亲自佩戴寻呼机支持这个项目已经4年多了，所有这些都是自愿的。

2015年是阅读文档的又一个伟大年份。我们已经解决了一些长期存在的问题，比如没有降价支持，并为文档社区构建了许多很棒的工具。

你总能看到我们最后的统计数据30天.

几个月前，Mozilla推出了一项新举措——MOSS公司程序–为其所依赖的开源软件项目提供资金支持。Mozilla向MOSS基金拨款100万美元，为多达10人提供资助符合项目标准的项目。

阅读文档是其中之一第一轮奖项专为MOSS计划打造。我们建议拨款48000美元，用于构建一个单独的实例随着Python Package Index即将推出的网站，仓库.此集成将在软件包发布时提供自动API参考文档与PyPI绑定的身份验证和发行版内的简单配置。每个版本上的API参考文档将是此操作的起点工作、散文文档的生成在这里会更加困难，因为不是所有的软件包使用Sphinx或rST进行文档记录。

阅读文档是建立在狮身人面像之上的，它一直依赖于reStructuredText作为输入机制。我们早就听说人们想用Markdown编写文档，以及RST。

今天我们宣布这是可能的！随着降价标准化通用标记，我们有能力支持具有适当规范的标记语言。推荐标志是允许Commonmark在狮身人面像内部使用的桥。这允许您在Sphinx项目中同时使用RST和Commonmark。

我们最近引入了一个基于Docker的新构建容器子系统来读取docs.org，这对于用户来说应该是最不被注意的。我们仍在解决系统中的一些错误，所以提出一个问题我们的问题跟踪器如果你注意到任何新问题使用您的项目生成。

这个新系统是过期安全更新的一部分，有助于隔离任意代码执行。随着阅读文档的增长，防止武断处决是一个迅速增长的问题。此构建隔离层是作为readthedocs.com的一部分开发，其中安全问题至关重要访问私有存储库。我们一直在测试它在自那时以来，社区网站一直没有承诺转换产品构建由于可能的副作用数量，服务器关闭。

八月对阅读文件具有历史意义，因此它似乎适合花点时间回顾一下我们在八月份的工作去年。

是什么让八月对我们如此重要？

八月对我们来说是一个忙碌的月份。事实上，我们太忙了，从来没有写过这个更新。我们未能按时发布这份报告，但希望能保持领先地位的未来更新。

7月是稳定修复的一个月，我们的基础设施。首先，这里是我们设定的一些目标的更新我们最近一次每月更新：

八月对我们来说是忙碌的一个月。编写欧洲文档是在月，我们的重点是阅读docs.com到公共测试状态。我们预算的3个月期限即将结束作为我们筹款活动的一部分，还有一些任务要完成。

首先，更新我们为本月设定的目标：

使用编写文档会议于5月结束，我们转移了注意力返回阅读5月和6月剩余时间的文档。关注我们的帖子可用合同职位使用阅读文件，我们雇佣了两名承包商与我们合作，专注于支持和readthedocs.org的稳定性。格雷戈·穆勒格将致力于支持和发展，以及安德鲁·克雷普斯帮助我们建立和改进我们的运营基础设施。

阅读文档在6月份有以下主要更新：

感谢我们的成功筹款人，我们有能力付钱给那些在阅读文档上工作的人。

我们正在寻找两个职位：

首先，对所有支持我们的人表示衷心的感谢。你们都帮助我们实现了资金目标，而且还有时间。我们很谦逊有这么多的支持，认识这么多人分享我们的伟大文档的愿景。

真的，谢谢大家。★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

2014年是阅读文件的又一个辉煌之年。该项目在开源生态系统中稳步增长，在Python社区之外进行大量扩展。我们构建了一系列出色的新功能，并继续改进开放源码世界的文档体验。

您可以随时在上查看我们最近30天的统计数据http://www.seethestats.com/site/readthedocs.org.

今天，我们宣布推出用于阅读文档的用户定义重定向。这是一个长期要求的功能，在迁移文档时应该减少404的功能。

阅读文档已经很久了重定向，但它们仅针对特定用例进行自动管理。此更改允许用户控制一组特定的通用重定向。

文档是软件项目中经常被忽视的部分。今天我们为您的文档发放徽章，这样人们就可以很容易地看到您的文档是最新的。

徽章的主要用途是显示项目构建的状态。它们将以绿色显示以供通行，红色表示失败，黄色表示未知状态。

欢迎来到阅读文档博客。

我们将在博客上定期发布功能。还有一些最近发布的功能，我们也将在那里重点介绍。

2013年对阅读文档.我们的任务是使文档托管更容易，总体目标是提高编程世界中文档的质量。我相信，我们一直在为实现这一目标而努力，我想分享一些数字，以反映我们的进展。

我们的社区今年很好。我很高兴看到一些人提交了多个补丁和功能。今年，我们有：

我们一直在努力工作改善阅读文档过去一个月。大量后端工作正在进行，现在我们有了一个全新的文档主题来展示它。

我们已经了解了人们如何使用文档，建造了一个美观且功能强大的新接口用于浏览文档。我们创建了一个看起来很棒并且运行良好的解决方案。