Sphinx 5.1

版本 5.1.1 (发布于 2022 年 7 月 26 日)

修复的 Bug

  • #10701: 修复新版基于 deque 的 sphinx.ext.napoleon 迭代器实现中的 ValueError。

  • #10702: 恢复与第三方构建器的兼容性。

版本 5.1.0 (发布于 2022 年 7 月 24 日)

依赖项

已弃用

  • #10467: sphinx.util.stemmer 已弃用，取而代之的是 snowballstemmer。补丁作者：Adam Turner。

  • #9856: sphinx.ext.napoleon.iterators 已弃用。

新增功能

  • #10444: HTML 主题：允许通过 theme.conf 中的 stylesheet 设置或将 html_style 设置为字符串可迭代对象来指定多个 CSS 文件。

  • #10366: 标准域：通过新的 option_emphasise_placeholders 配置选项，在 option 指令中添加了对强调占位符的支持。

  • #10439: 标准域：在显示警告时使用某些变量的 repr，使空白问题更易于识别。

  • #10571: quickstart：减少生成的 conf.py 文件中的内容。补丁作者：Pradyun Gedam。

  • #10648: LaTeX: 类似 CSS 命名的附加 ‘sphinxsetup’ 键允许配置四个独立的边框宽度、四个内边距、四个圆角半径、一个阴影（可能嵌入）、边框颜色、背景颜色、阴影颜色，用于代码块、主题、注意、警告、危险、错误和警告指令。

  • #10655: LaTeX: 解释 LatinRules.xdy 中的非标准编码

  • #10599: HTML 主题：在使用 Docutils 0.18 或更高版本时，将连续的脚注包裹在 <aside> 元素中，以便更轻松地设置样式。这与 Docutils 0.19 中引入的行为一致。补丁作者：Adam Turner。

  • #10518: 配置：添加 include_patterns 作为 exclude_patterns 的反义。补丁作者：Adam Turner。

修复的 Bug

  • #10594: HTML 主题：如果使用 Docutils 0.18+，字段术语冒号会加倍。

  • #10596: 如果 Docutils 版本为 0.18（而非 0.18.1），则由于缺少 Node.findall() 导致构建失败。

  • #10506: LaTeX: 如果在图标题中突出显示行内代码角色，则构建错误 (refs: #10251)。

  • #10634: 使 -P (pdb) 选项更好地处理由事件触发的异常。

  • #10550: py 域：修复解析各种运算符（+, -, ~, 和 **）时出现的假空格。补丁作者：Adam Turner (refs: #10551)。

  • #10460: 日志：始终将节点源位置显示为绝对路径。

  • HTML 搜索：HTML 标签显示为对象名称的一部分。

  • HTML 搜索：搜索片段不应折叠。

  • HTML 搜索：获取搜索片段时会发出次要错误。

  • HTML 搜索：标题链接的标记显示在搜索结果中。

  • #10520: HTML 主题：修复 agogo.css_t 中侧边栏类的使用。

  • #6679: HTML 主题：修复 agogo 主题中隐藏 toctree 的包含问题。

  • #10566: HTML 主题：修复 enable_search_shortcuts 不起作用的问题。

  • #8686: LaTeX: 文本可能会在页面末尾超出代码块，并在下一页留下残余。

  • #10633: LaTeX: 由于上游 framed.sty 错误，用户在主题或警告框中注入的 \color 命令可能导致 PDF 中出现颜色泄漏。

  • #10638: LaTeX: 高亮代码中的有框彩色框（例如使用 Pygments 样式 'manni' 高亮的 diff）继承了代码块框架的厚度。

  • #10647: LaTeX: 即使 desc_signature 节点有多个节点 ID，也只生成一个 \label。

  • #10579: i18n: 翻译原始指令时引发 UnboundLocalError。

  • #9577, #10088: py 域：修复在使用 :any: 和 autodoc 时重复的 Python 引用警告。

  • #10548: HTML 搜索：修复次要摘要问题。