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 已弃用，取而代之的是 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

  • 为 -j 添加 --jobs 同义词。由 Hugo van Kemenade 提交补丁

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

  • LaTeX: 添加 \sphinxstylenotetitle, …, \sphinxstylewarningtitle, …, 用于额外的标记层，以解放 \sphinxstrong 用于其他用途。请参阅 Macros。(参考: #11267)

  • LaTeX: note、hint、important 和 tip 现在可以像其他警示框一样样式化，即可能带有背景颜色、单独的边框宽度和内边距、可能圆角和可选阴影。请参阅 Additional CSS-like 'sphinxsetup' keys。(参考: #11234)

  • LaTeX: 警示框和 topic (以及 contents) 指令，而不仅仅是 code-block，支持 box-decoration-break=slice。

  • LaTeX: 让圆角框支持最多 4 种不同的边框宽度 (参考: #11243)

  • LaTeX: 新选项 noteTextColor、noteTeXextras 等。请参阅 Additional CSS-like 'sphinxsetup' keys。

  • 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: 修复当一个或多个 reST 标签直接位于 py:module 或 automodule 指令之前时，“多重定义引用” PDF 构建警告。由 Bénédikt Tran (picnixz) 提交补丁

  • #11110: LaTeX: 如果图的文件具有相同的基本名称并且它们使用了后置转换，则图会从 latex pdf 中丢失。由 aaron-cooper 提交补丁

  • LaTeX: 修复当设置了阴影颜色但未设置边框颜色时，阴影可能渗漏到圆角框边框的潜在问题

  • LaTeX: 修复代码块框架相对于内容（使用圆角时）意外向上垂直偏移 1pt 的问题

  • #11235: LaTeX: 话题（或警示框）内容中添加 \color 可能会在分页符处导致颜色渗漏到阴影和边框

  • #11264: LaTeX: 法语中 seealso 指令的“Voir aussi”后缺少冒号前的空格

  • #11268: LaTeX: 带有左对齐的 longtable 在 PDF 中会超出当前列表缩进上下文。感谢 picnixz。

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

  • #11147: 修复对象描述内容和 nested_parse_with_titles 其他用途中的源文件/行号信息。由 Jeremy Maitin-Shepard 提交补丁。

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

  • 使用新的 Transifex tx 客户端

测试

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

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

  • 移除依赖于 setuptools 的测试