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

新闻和更新

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

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

  • 1️⃣我们将在未来建立一个主要营销网站,同时仍在为我们的社区和商业用户运行两种不同的产品。现在所做的第一个更改是重定向上已注销的用户https://readthedocs.com/关于.readthedocs.com.我们将很快为登录到https://readthedocs.org网站/,除了特定于项目的子页面。

  • 🧹我们现在可以从搜索引擎中删除非官方项目。如果你发现一个非官方和未维护的项目,请参阅我们关于非官方和未维护项目的政策.

  • 🐞 使用Sphinx DirHTML构建器定制404现在支持.

  • 🔒已修复漏洞:在主文档域上提供来自pull请求预览的内容.

  • 🔒已修复漏洞:路径遍历:从任何项目访问文件.

您可以在我们的阅读文档更改日志.

即将到来的

  • 🪄处理所有托管文档上未缓存请求的Django应用程序称为El Proxito。该应用程序正在进行重大重构,提高速度和功能。大多数重构工作已经合并,在未来几周内,我们将开始逐步启用它,同时监控是否存在问题。

  • 📚文档重构正在进行:我们的定期读者用户文档可能会注意到我们的导航已经发生了很大的变化,现在只包含4种的士类别.我们的Diátaxis文档重构的第一项工作现在已经上线,一般工作已经转移到更短的迭代中。一旦我们从重构中收集了所有的最终经验,我们将与其他文档项目如何实现这种重构的实际输入一起发布它。

  • 💬️ …如果您正在计划对现有文档项目进行重构,我们很想知道你的问题和担忧是什么,并解决这些未来的博客帖子和谈话。

  • 🐞拉取请求生成应该指向预览,而不是生成页面。修复将在中就绪#10085.

  • 🎬我们正在慢慢走向v2仪表板体验的公开测试版。下面是将要发生的事情的屏幕截图…

../_images/screenshot仪表板-beta.png

Read the Docs Dashboard v2上构建页面的屏幕截图。

想跟上我们的发展进程吗?查看我们的完整路线图📍

本月最棒的项目

Haskell工具组在世界上广为人知哈斯克尔简单地说就是Stack,是本月的精选条目很棒的阅读文档项目🕶️.下面是我们从Stack文档中选择的亮点推特帖子:

当月小费

当你在聊天和社交媒体上发布文档链接时,您可能会看到一个通用预览。输入狮身人面像笔!

这个狮身人面像扩展允许您配置自己的预览卡,兼容所有主要聊天和社交媒体平台。我们真正喜欢的一个特性是,扩展将检测并使用文档页面中的第一个插图。如果你想看到它的行动,尝试共享此新闻稿博客帖子的链接(无意中进行了营销)。我们的用户文档也在使用sphinxext-opengraph。


问题?评论?对下一份新闻稿有什么想法?联系我们!