Sphinx 6.2

版本 6.2.1（发布于 2023 年 4 月 25 日）

修复的bug

版本 6.2.0 （发布于 2023 年 4 月 23 日）

依赖

  • 需要 Docutils 0.18.1 或更高版本.

不兼容的更改

  • LaTeX:根据 sphinx.sty 中 5.1.0 的代码注释,移除了一些内部 TeX \dimen 寄存器（之前未公开文档）: \sphinxverbatimsep 、 \sphinxverbatimborder 、 \sphinxshadowsep 、 \sphinxshadowsize 和 \sphinxshadowrule .（参考:#11105）

  • 从pycode的 ModuleAnalyser 中移除 .egg 支持;Python eggs现在已经是过时的二进制分发格式

  • #11089: 删除 sphinx.builders.linkcheck 中不推荐使用的代码.补丁由 Daniel Eades 提供

  • 移除仅限内部使用的 sphinx.locale.setlocale

过时

  • #11247: 弃用遗留的 intersphinx_mapping 格式

  • sphinx.util.osutil.cd is deprecated in favour of contextlib.chdir.

添加的功能

  • #11277: autoproperty 允许将返回类型指定为类型注释（例如, # type: () -> int ）.补丁由Bénédikt Tran提供

  • #10811: Autosummary: 当选项 autosummary_ignore_module_all 设置为 False 时,扩展模板渲染的 __all__ 到导入的成员.补丁由 Clement Pinard 提供

  • #11147: 为 nested_parse_with_titles() 添加一个 content_offset 参数,以便在嵌套解析时获得正确的行号.补丁由 Jeremy Maitin-Shepard 提供

  • 更新至Unicode CLDR 42

  • 添加 --jobs 的同义词 -j .补丁由 Hugo van Kemenade 提供

  • LaTeX: 添加了一个命令 \sphinxbox 用于使用（可能是圆角的）框、可选背景颜色和阴影来样式化文本元素.请参阅 The \sphinxbox command . (refs: #11224)

  • LaTeX: 添加 \sphinxstylenotetitle ,…, \sphinxstylewarningtitle ,…,以增加一层标记,这样可以将 \sphinxstrong 留给其他用途.请参见 宏 .（参考:#11267）

  • LaTeX: note 、hint 、important 和 tip 现在可以各自被样式化为其他告诫,即可能具有背景颜色、不同的边框宽度和内边距、可能的圆角和可选的阴影.见 额外的 CSS 类似的 'sphinxsetup' 键 . (refs: #11234)

  • LaTeX: 提示和 topic （以及 contents ）指令,不仅 code-block ,支持 box-decoration-break=slice .

  • LaTeX:让圆角框支持多达4种不同的边框宽度（参考:#11243）

  • LaTeX:新增选项 noteTextColor 、 noteTeXextras 等.请参见 额外的 CSS 类似的 'sphinxsetup' 键 .

  • LaTeX: 支持圆角框中的椭圆形角. (参考: #11254)

  • #11150: 在词法分析失败时,在高亮警告中包含源位置.补丁由Jeremy Maitin-Shepard提供

  • #11281: 支持 imgmath_latex```= 'tectonic' ``或` = ‘xelatex’`` .补丁由 Dimitar Dimitrov 提供

  • #11109, #9643: 添加 python_display_short_literal_types 选项,以便对 Literal 类型进行简洁渲染.

修复的bug

  • #11079: LaTeX: 带有 align 属性的图形可能会消失,并奇怪地影响后续列表

  • #11093: LaTeX: 修复 PDF 构建警告中 “多重定义引用” 问题,当一个或多个 reST 标签直接位于 py:module 或 automodule 指令之前时.补丁由 Bénédikt Tran (picnixz) 提供.

  • #11110: LaTeX: 如果图像文件具有相同的基本名称并且使用后处理变换,图像将从latex pdf中消失.补丁由aaron-cooper提供

  • LaTeX:修复从圆角框的阴影到边框的潜在颜色泄漏,前提是设置了阴影颜色但未设置边框颜色

  • LaTeX:修复代码块框架相对于内容的不必要的1pt上移（在使用圆角时）

  • #11235: LaTeX: 在主题（或警告）内容中添加 \color 可能导致颜色泄漏到页面断裂处的阴影和边框

  • #11264:LaTeX:在法语中”Voir aussi”后缺少冒号前的空格,影响:rst:dir:seealso 指令

  • #11268: LaTeX:长表格左对齐在PDF中打断当前列表缩进上下文.感谢picnixz.

  • #11274:LaTeX:外部链接未为 \sphinxupquote 兼容性正确转义

  • #11147: 修复对象描述内容中的源文件/行号信息以及其他使用 nested_parse_with_titles 的地方.补丁由 Jeremy Maitin-Shepard 提供.

  • #11192: 恢复正确的并行搜索索引构建.补丁由 Jeremy Maitin-Shepard 提供

  • 使用新的 Transifex tx 客户端

测试

  • 当发出任何 Python 警告时失败测试

  • 将剩余的 unittest.TestCase 风格测试函数迁移到 pytest 风格

  • 移除依赖于setuptools的测试