发布于2021年

2021年世界各地的狮身人面像和马克顿

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

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

阅读更多。。。


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

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

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

阅读更多。。。


发布Embed API v3和sphinx-hoverxref 1.0

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

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

阅读更多。。。


阅读文档❤️ Jupyter图书

我们自豪地宣布,现在阅读文档支持Jupyter Book项目!

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

阅读更多。。。


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

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

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

阅读更多。。。


使用docutils 0.18生成错误

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

那么,发生了什么?

阅读更多。。。


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

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

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

阅读更多。。。


阅读文档时事通讯-2021年10月

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

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

阅读更多。。。


阅读文档时事通讯-2021年9月

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

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

阅读更多。。。


主题发布1.0.0rc1

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

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

阅读更多。。。


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

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

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

阅读更多。。。


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

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

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

阅读更多。。。


2021年初,Read the Docs的讲座和播客

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

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

阅读更多。。。


支持sphinx的sphinx-hoverxref新版本

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

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

阅读更多。。。


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

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

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

阅读更多。。。


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

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

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

阅读更多。。。


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

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

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

阅读更多。。。


阅读Docs时事通讯-2021年4月

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

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

阅读更多。。。


阅读Docs 2020统计数据

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

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

阅读更多。。。


API v3现已稳定

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

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

阅读更多。。。


阅读文档社区因迁移到AWS而停机

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

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

阅读更多。。。


所有用户都可以使用Pull Request Builder

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

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

阅读更多。。。


阅读业务维护窗口的文档-2月5日

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

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

阅读更多。。。


阅读Docs正在招聘多个职位

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

A类具有设计技能的前端开发人员

阅读更多。。。