Sphinx 4.5

Release 4.5.0（发布于2022年3月28日）

不兼容的更改

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

  • #9993, #10177: 标准域:不允许通过 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

修复的错误

  • #9876: autodoc: 无法记录从本地二进制模块构建的导入类

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

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

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

  • #10205: extlinks: 在检查硬编码链接时,无法编译正则表达式

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

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

  • #9924: LaTeX: multi-line cpp:function 指令在 LaTeX PDF 中具有较大的垂直间距

  • #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命令的安装情况