Sphinx 7.4

发布版本 7.4.7（于2024年7月20日发布）

修复的错误

  • #12096: 当文件在构建目录中被覆盖时发出警告.补丁由Adam Turner和Bénédikt Tran提供.

  • #12620: 确保遵循旧样式对象描述选项.补丁由 Adam Turner 提供.

  • #12601, #12625: 支持在Python域中使用:py:class:~typing.Annotated 类型元数据中的可调用对象.补丁由Adam Turner提供.

  • #12601,#12622:解决与 sphinx.ext.autodoc 的 Annotated 警告,特别是在使用 dataclasses 作为类型元数据时.补丁由 Adam Turner 提交.

  • #12589, #12626: autosummary: 修复有关 autolink 的警告.补丁由 Adam Turner 提供.

发布 7.4.6 （发行日期:2024年7月18日）

修复的错误

  • #12589, #9743, #12609: autosummary: 在为包内模块生成autosummary指令时,不要添加包前缀.补丁由Adam Turner提供.

  • #12613: 在库存加载期间降低模糊检测的日志严重性.补丁由 James Addison 提供.

Release 7.4.5（发布于 2024 年 7 月 16 日）

修复的错误

  • #12593,#12600:恢复将选定的 html_sidebars 值的类型强制转换为列表.当检测到字符串值时记录错误信息.补丁由 Adam Turner 提供.

  • #12594: LaTeX: 自7.4.0以来,:rst:dir:seealso 和其他”轻量”的告诫现在会在包含:dudir:figure 指令时中断PDF构建;如果它们位于一个表格单元格中（通过 tabulary 渲染）也会如此.补丁由Jean-François B.提供.

发布版本 7.4.4（于 2024 年 7 月 15 日发布）

修复的错误

  • #12585, #12586: 当intersphinx清单包含大小写不敏感的重复项目时,不要发出警告.补丁由James Addison提供.

版本 7.4.3（发布于 2024年7月15日）

修复的错误

  • #12582:恢复对使用注册解析器的扩展的列表样式 source_suffix 值的支持.补丁由 Adam Turner 提供.

发布 7.4.2（发布于 2024 年 7 月 15 日）

修复的错误

  • #12580, #12583: 解决在增量构建时使用 Sphinx 7.3.7 及更早版本时 C 域的失败.补丁由 Adam Turner 提供.

版本 7.4.1 （发布日期:2024年7月15日）

修复的错误

  • 修复当使用无效的 heading-level 的 rubric 节点时产生的无效 HTML.补丁由 Adam Turner 提供.

  • #12579, #12581: 恢复对 typing.ParamSpec 在 autodoc 中的支持.补丁由 Adam Turner 提供.

发布版本 7.4.0（于2024年7月15日发布）

依赖关系

  • #12555: 放弃对Docutils 0.18.1和Docutils 0.19的支持.补丁由Adam Turner提供.

  • LaTeX:现在需要 xcolor 包（但例如它是 Ubuntu texlive-latex-recommended 的一部分,之前一直是必需的）.

  • LaTeX:现在在PDF输出的警告标题中使用的默认图标选择需要 fontawesome5 LaTeX包;如果不可用,PDF构建将默默跳过渲染此类图标.有关更多信息,请查看:ref:’sphinxsetup’ <latexsphinxsetup> 的 iconpackage 键的文档.

过时

  • LaTeX:sphinxlightbox 环境不再使用,所有类型的警告默认仅使用 sphinxheavybox .

新增特性

  • #11165: 支持官方推荐的 .jinja 后缀用于模板文件.补丁由 James Addison 和 Adam Turner 提供

  • #12325: 将 Union[Literal[T], Literal[U], ...] 展平为 Literal[T, U, ...] 在将注释转换为字符串时.补丁由 Adam Turner 提供.

  • #12319:sphinx.ext.extlinks : 为链接添加 extlink-{name} CSS 类.补丁由 Hugo van Kemenade 提供.

  • #12387: 改进 CLI 进度消息,复制资产时.补丁由 INADA Nakoi 和 Bénédikt Tran 提供.

  • #12361: 添加 BuildEnvironment.parser .补丁由 Chris Sewell 提供.

  • #12358: 添加 Sphinx.fresh_env_used .补丁由 Chris Sewell 提供.

  • #12329: 增加在加载和解析Intersphinx目标时检测模糊的 std:label 和 std:term 引用.补丁由James Addison提供.

  • #12422: 不要在内置主题的aria-label中重复”navigation”.补丁由Thomas Weißschuh提供

  • #12421: 在内置主题的 logo_alt 中包含项目名称.补丁由 Thomas Weißschuh 提供

  • #12448: 添加 sphinx-apidoc --remove-old 选项.补丁由 Chris Sewell 提供.

  • #12456: 添加 sphinx-autogen --remove-old 选项.补丁由 Chris Sewell 提供.

  • #12479: 添加警告子类型 toc.no_title .补丁由Ondřej Navrátil提供.

  • #12492:添加辅助方法,用于从指令内部将reStructuredText内容解析为节点.

    由Adam Turner修补.

  • #12258: 支持 typing_extensions.Unpack 的补丁,由 Bénédikt Tran 和 Adam Turner 提供.

  • #12524: 为 toctree 指令添加 class 选项.补丁由 Tim Hoffmann 提供.

  • #12536: 添加:rst:dir:confval 指令.补丁由Adam Turner提供.

  • #12537: c_id_attributes ,:confval:c_paren_attributes ,:confval:cpp_id_attributes 和 cpp_paren_attributes 现在可以是字符串元组.:confval:c_extra_keywords ,:confval:gettext_additional_targets ,:confval:html_domain_indices ,:confval:latex_domain_indices 和 texinfo_domain_indices 现在可以是字符串集合.补丁由 Adam Turner 提供.

  • #12523: 添加了配置选项 math_numsep ,用于定义数学编号的分隔符.补丁由 Thomas Fanning 提供

  • #11592: 将 coverage_modules 添加到覆盖构建器,以允许明确指定应记录哪些模块.补丁由 Stephen Finucane 提供.

  • #7896, #11989: 添加一个 py:type 指令用于文档类型别名,以及一个 py:type 角色用于链接到它们.补丁由 Ashley Whetter 提供.

  • #12549: 为 Sphinx.add_config_value() 添加可选的 description 参数.补丁由 Chris Sewell 提供.

  • #6792: 禁止在 sphinx.ext.autosummary 中出现模块导入循环.补丁由 Trevor Bekolay 提供.

  • #12508:LaTeX:重新设计所有告诫的样式,增加了带图标的标题行.补丁由Jean-François B.提供.

  • #11773: 在Python域中显示 Annotated 注解及其元数据.补丁由Adam Turner和David Stansby提供.

  • #12506: 为 rubric 指令添加 heading-level 选项.补丁作者:Chris Sewell.

  • #12567: 添加 write-started 事件.补丁来自 Chris Sewell.

修复的错误

  • #12314: 在注释中正确格式化 collections.abc.Callable .补丁由 Adam Turner 提供.

  • #12162: 修复自3.0.0版本以来在C域中存在的性能回归.补丁由唐纳德·亨特提供.

  • #12320: 修复从搜索摘要中移除锚点的问题（7.3.0中的回归）.补丁由Will Lachance提供.

  • #12251: 修复 merge_domaindata() 在 sphinx.ext.duration 中的问题.补丁由Matthias Geier提供.

  • #12224: 正确检测WebP文件.补丁由Benjamin Cabé提供.

  • #12380: LaTeX: 当 N 已经是当前页码时,避免脚注标记 Page N .补丁由 Jean-François B. 提供.

  • #12410: LaTeX:对于法语和 'lualatex' 作为:confval:latex_engine ,使用 babel ,与 'xelatex' 一致（而不是 polyglossia ）.补丁由Jean-François B.提供.

  • #8807, #12520: LaTeX: 让 todolist 在PDF中生成正确的超链接.补丁由 Jean-François B. 提供.

  • #12416: 确保在修改任一值时,配置设置别名始终保持同步.补丁由Bénédikt Tran提供.

  • #12220: 修复加载 en locale 的自定义模板翻译.补丁由 Nicolas Peugnet 提供.

  • #12459: 为 linkcheck_rate_limit_timeout 配置设置添加有效类型参数.补丁来自 James Addison.

  • #12331: 解决v7.3.0中数据URI图像提取的回归问题,该问题影响不支持数据URI输出格式的生成器.补丁由James Addison提供.

  • #12494: 修复翻译文档产生的无效 genindex.html 文件（在 7.1.0 中回归）.补丁由 Nicolas Peugnet 提供.

  • #11961: 在搜索索引中省略文档标题条目的锚引用,去除搜索结果的重复.补丁由James Addison提供.

  • #12425:在HTML构建器中使用Docutils的SVG处理,并移除Sphinx的自定义逻辑.补丁由Tunç Başar Köse提供.

  • #12391:调整HTML搜索时的匹配评分,使文档的主标题相对于子标题更容易排名更高.此外,相较于标题/副标题的匹配,增强编程领域对象名称的匹配评分.补丁由James Addison和Will Lachance提供.

  • #9634:请勿通过去除国家代码来添加后备语言.补丁由Alvin Wong提供.

  • #12352: 将领域对象按文档中定义的顺序添加到目录中.以前,每个领域使用特定语言的嵌套规则,这使文档作者无法控制.补丁由Jakob Lykke Andersen和Adam Turner提供.

  • #11041: linkcheck: 忽略返回非Unicode内容的URL.由James Addison修补.

  • #12543:修复 LaTeX 输出的 PEP 695 格式.补丁由 Bénédikt Tran 提供.

测试

  • karma: 重构 HTML 搜索测试,以使用 Sphinx 生成的测试数据.补丁由 James Addison 提供.