Sphinx 4.5

版本 4.5.0 (发布于 2022 年 3 月 28 日)

不兼容的变更

  • #10112: extlinks: 默认禁用硬编码链接检测器

  • #9993, #10177: std 域: 禁止通过 ref 角色引用内联目标

已弃用

  • sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()

新增功能

  • #10260: 为终端着色启用 FORCE_COLOR 和 NO_COLOR

  • #10234: autosummary: 向摘要表添加 “autosummary” CSS 类

  • #10125: extlinks: 改进对有标题的引用的建议消息

  • #10112: extlinks: 添加 extlinks_detect_hardcoded_links 以启用硬编码链接检测器功能

  • #9494, #9456: html 搜索: 添加配置变量 html_show_search_summary 以启用/禁用搜索摘要

  • #9337: HTML 主题，添加选项 enable_search_shortcuts，启用 / 作为快速搜索快捷方式，并启用 Esc 快捷方式以移除搜索高亮显示。

  • #10107: i18n: 允许通过在每个翻译消息的末尾添加 #noqa 注释来抑制翻译警告

  • #10252: C++，支持类、联合和枚举上的属性。

  • #10253: pep 角色现在根据 peps.python.org 生成 URL

修复的 Bug

  • #9876: autodoc: 未能文档化从原生二进制模块构建的导入类

  • #10133: autodoc: 当模拟模块用于类型注释时崩溃

  • #10146: autodoc: autodoc_default_options 不支持 no-value 选项

  • #9971: autodoc: 当目标对象由不可哈希对象注释时引发 TypeError

  • #10205: extlinks: 检查硬编码链接时编译正则表达式失败

  • #10277: html 搜索: 无法搜索短词 (例如 “use”)

  • #9529: LaTeX: 被多次引用的命名自动编号脚注 (例如 [#named]) 被渲染为问号

  • #9924: LaTeX: 多行 cpp:function 指令在 Latexpdf 中有很大的垂直间距

  • #10158: LaTeX: 自 v4.4.0 以来，未文档化的变量/结构成员的空白过多

  • #10175: LaTeX: 如果名称在不同的文档中也被使用，命名脚注引用链接到不正确的脚注

  • #10269: manpage: 无法解析 ref 交叉引用的标题

  • #10179: i18n: 抑制 “rST 本地化” 警告

  • #10118: imgconverter: 为远程 URI 调用了不必要的可用性检查

  • #10181: napoleon: 当 napoleon_use_ivar 启用时，属性对于谷歌风格的文档字符串显示得像类属性

  • #10122: sphinx-build: make.bat 在显示帮助之前不检查 sphinx-build 命令的安装