帖子发布者安东尼-约翰逊

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

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

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

阅读更多。。。


使用docutils 0.18生成错误

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

那么,发生了什么?

阅读更多。。。


主题发布1.0.0rc1

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

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

阅读更多。。。


将新项目默认为Python 3

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

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

阅读更多。。。


传入Webhook弃用

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

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

阅读更多。。。


Python 3.6支持

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

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

阅读更多。。。


2017年PyCon回顾

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

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

阅读更多。。。


2017年5月12日发布

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

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

阅读更多。。。


生成映像升级

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

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

阅读更多。。。


保护子域

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

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

阅读更多。。。


阅读获得Mozilla开源支持拨款的文档

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

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

阅读更多。。。


确保构建过程的安全

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

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

阅读更多。。。


文件的状态

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

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

阅读更多。。。


报告-2015年7月

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

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

阅读更多。。。


报告-2015年8月

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

首先,更新我们为本月设定的目标:

阅读更多。。。


报告-2015年6月

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

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

阅读更多。。。


筹资总结

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

真的,谢谢大家。★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

阅读更多。。。