Sphinx7.4

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

错误已修复

  • #12096：当生成目录中的文件被覆盖时发出警告。Adam Turner和Bénédikt Tran的补丁。

  • #12620：确保尊重老式对象描述选项。Adam Turner的补丁。

  • #12601、#12625：支持中的可调用对象 Annotated 在Python域中输入元数据。Adam Turner的补丁。

  • #12601、#12622：解决 Annotated 警告 sphinx.ext.autodoc ，尤其是使用时 dataclasses 作为类型元数据。Adam Turner的补丁。

  • #12589，#12626：自动摘要：用修复警告 autolink . Adam Turner的补丁。

版本7.4.6（2024年7月18日发布）

错误已修复

  • #12589、#9743、#12609：自动摘要：为包内的模块生成自动摘要指令时，不要添加包前置。Adam Turner的补丁。

  • #12613：降低库存加载期间模糊性检测的日志严重性。詹姆斯·艾迪生的补丁。

版本7.4.5（2024年7月16日发布）

错误已修复

  • #12593、#12600：恢复强制选定的类型 html_sidebars 值到列表中。检测到字符串值时记录错误消息。Adam Turner的补丁。

  • #12594：LaTeX：自7.4.0起， seealso 如果PDF构建包含 figure 指令;以及它们是否包含在表单元格中（由 tabulary ).补丁：让-弗朗索瓦·B。

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

错误已修复

  • #12585、#12586：当interphinx库存包含不区分大小写模糊的重复项目时，不要发出警告。詹姆斯·艾迪生的补丁。

版本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日发布）

错误已修复

  • 当标题节点无效时修复无效的HTML heading-level 采用了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：The xcolor 现在需要包（但例如是Ubuntu的一部分 texlive-latex-recommended 这一直是必需的）。

  • LaTeX：The fontawesome5 LaTeX包需要用于PDF输出中的警告标题中现在使用的图标的默认选择;但如果不可用，PDF构建版本将简单地省略呈现此类图标。 检查 iconpackage 关键 'sphinxsetup' 了解更多。

弃用

  • LaTeX：The sphinxlightbox 不再使用环境，仅使用（默认情况下）所有类型的警告 sphinxheavybox .

功能添加

  • #11165：支持 officially recommended .jinja 模板文件的后缀。詹姆斯·艾迪生和亚当·特纳的补丁

  • #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：添加歧义检测 std:label 和 std:term 加载和解析Interphinx目标期间的引用。詹姆斯·艾迪生的补丁。

  • #12422：不要在内置主题的咏叹调标签中重复“导航”。托马斯·韦茨舒赫（Thomas Weiisse schuh）的补丁

  • #12421：包括项目名称 logo_alt 内置主题。托马斯·韦茨舒赫（Thomas Weiisse schuh）的补丁

  • #12448：添加 sphinx-apidoc --remove-old 选项.克里斯·休厄尔（Chris Sewell）的补丁。

  • #12456：添加 sphinx-autogen --remove-old 选项.克里斯·休厄尔（Chris Sewell）的补丁。

  • #12479：添加警告子类型 toc.no_title .补丁由Ondej Navrá蒂尔。

  • #12492：添加帮助器方法，用于从指令中将reStructuredText内容解析为节点。

    Adam Turner的补丁。

  • #12258：支持 typing_extensions.Unpack 补丁由Bénédikt Tran和Adam Turner制作。

  • #12524：添加 class 选项到 toctree 指令。蒂姆·霍夫曼修补。

  • #12536：添加 confval 指令。Adam Turner的补丁。

  • #12537： c_id_attributes , c_paren_attributes , cpp_id_attributes ，而且 cpp_paren_attributes 现在可以是字符串的数组。 c_extra_keywords , gettext_additional_targets , html_domain_indices , latex_domain_indices ，而且 texinfo_domain_indices ，现在可以是一组字符串。Adam Turner的补丁。

  • #12523：添加了配置选项， math_numsep ，定义数学编号的分隔符。托马斯·范宁的补丁

  • #11592：添加 coverage_modules 覆盖范围构建器，以允许明确指定哪些模块应该被记录。斯蒂芬·菲纽肯的补丁。

  • #7896、#11989：添加 py:type 用于记录类型别名的指令，以及 py:type 与它们链接的角色。阿什利·惠特（Ashley Whitter）的补丁。

  • #12549：添加可选 description 论点 Sphinx.add_config_value() .克里斯·休厄尔（Chris Sewell）的补丁。

  • #6792：收件箱模块导入循环 sphinx.ext.autosummary .补丁由特雷弗·贝科利（Trevor Bekolay）制作。

  • #12508：LaTeX：修改了所有警告的样式，添加了带有图标的标题行。补丁：让-弗朗索瓦·B。

  • #11773：显示 Annotated 注释及其元数据在Python域中。Adam Turner和David Stansby的补丁。

  • #12506：添加 heading-level 选项 rubric 指令。克里斯·休厄尔（Chris Sewell）的补丁。

  • #12567：添加 write-started 活动克里斯·休厄尔（Chris Sewell）的补丁。

错误已修复

  • #12314：正确格式 collections.abc.Callable 在注释中。Adam Turner的补丁。

  • #12162：修复C域中自3.0.0版本以来一直存在的性能回归。唐纳德·亨特的补丁。

  • #12320：修复从搜索摘要中删除锚点的问题（7.3.0中的回归）。威尔·拉钱斯（Will Lachance）的补丁。

  • #12251：修复 merge_domaindata() 在 sphinx.ext.duration .补丁由马蒂亚斯·盖尔（Matthias Geier）制作。

  • #12224：正确检测WebP文件。本杰明·卡贝的补丁。

  • #12380：LaTeX：避免脚注标记 Page N 当 N 已经是当前的页面号。补丁：让-弗朗索瓦·B。

  • #12410：LaTeX：适合法语和 'lualatex' 作为 latex_engine 使用 babel 如同 'xelatex' (and不 polyglossia ).补丁：让-弗朗索瓦·B。

  • #8807，#12520：LaTeX：let todolist 在PDF中生成正确的超链接。补丁：让-弗朗索瓦·B。

  • #12416：确保在修改一个或另一个值时始终同步配置设置别名。由Bénédikt Tran修补。

  • #12220：修复加载自定义模板翻译的问题 en 地点。尼古拉斯·皮格纳特（Nicolas Peugnet）的补丁。

  • #12459：将有效类型参数添加到 linkcheck_rate_limit_timeout 配置设置。詹姆斯·艾迪生的补丁。

  • #12331：解决v7.3.0中影响构建器的data-URI-image-extraction回归问题，而输出格式中的data-uri-image-extraction。詹姆斯·艾迪生的补丁。

  • #12494：修复使用翻译的文档生成的无效genindex.html文件（7.1.0中的回归）。尼古拉斯·皮格纳特（Nicolas Peugnet）的补丁。

  • #11961：省略搜索索引中文档标题条目中的锚点引用，删除搜索结果的重复。詹姆斯·艾迪生的补丁。

  • #12425：在HTML构建器中使用Docutils的JPEG处理并删除Sphinx的自定义逻辑。补丁由Tunnel Baikar Köse完成。

  • #12391：在HTML搜索期间调整匹配的评分，以便文档主标题的排名往往高于小节标题。此外，相对于标题/字幕匹配，增强编程域对象名称的匹配。补丁由詹姆斯·艾迪生和威尔·拉钱斯完成。

  • #9634：不要通过删除国家代码来添加后备语言。由Alvin Wong修补。

  • #12352：以与文档中定义的相同顺序将域对象添加到内容列表中。以前，每个域都使用特定于语言的嵌套规则，这会剥夺文档作者的控制权。由Jakob Lykke Andersen和Adam Turner制作。

  • #11041：linkcheck：忽略响应非Unicode内容的URL。詹姆斯·艾迪生的补丁。

  • #12543：修复 PEP 695 LaTeX输出的格式化。由Bénédikt Tran修补。

测试

  • karma：重构HTML搜索测试以使用Sphinx生成的固定装置。詹姆斯·艾迪生的补丁。