Sphinx8.1¶

版本8.1.3（2024年10月13日发布）¶

错误已修复¶

#13013：恢复支持 cut_lines() 没有对象类型。Adam Turner的补丁。

版本8.1.2（2024年10月12日发布）¶

错误已修复¶

#13012：暴露 sphinx.errors.ExtensionError 在 sphinx.util 用于向后兼容性。这将在Sphinx 9中删除，因为在中公开了异常 sphinx.util 从来都不是故意的。 ExtensionError 以来就是 sphinx.errors 自狮身克斯0.9以来。Adam Turner的补丁。

版本8.1.1（2024年10月11日发布）¶

错误已修复¶

#13006：使用首选的https://www.cve.org/ URL :cve: 作用雨果·范·凯梅纳德（Hugo van Kemenade）的补丁。
#13007：LaTeX：在需要时提高弹性 fontawesome 或 fontawesome5 未安装包。补丁：让-弗朗索瓦·B。

版本8.1.0（2024年10月10日发布）¶

依赖关系¶

#12756：添加下限 sphinxcontrib-* 个依赖项Adam Turner的补丁。
#12833：更新LaTeX parskip 2001年至2018年的套件。补丁：让-弗朗索瓦·B。

不兼容的更改¶

#12763：删除未使用的内部类 sphinx.util.Tee . Adam Turner的补丁。
#12822: LaTeX: for Unicode engines, the 'fvset' default is changed to '\\fvset{fontsize=auto}' from '\\fvset{fontsize=\\small}'. Code-blocks are unchanged as FreeMono is now loaded with Scale=0.9. An adjustment to existing projects is needed only if they used a custom 'fontpkg' configuration and did not set 'fvset'. Patch by Jean-François B.
#12875：禁用语言的smartquotes： zh_CN 和 zh_TW 在默认情况下由A修补。拉扎尔·汗。

弃用¶

#12762：亵渎 sphinx.util.import_object .使用 importlib.import_module() 而不是. Adam Turner的补丁。
#12766：亵渎 sphinx.util.FilenameUniqDict 和 sphinx.util.DownloadFiles . Adam Turner的补丁。

功能添加¶

#11328：提及静态输出文件生成期间模板化内容的评估。詹姆斯·艾迪生的补丁。
#12704：LaTeX：制造 contents , topic ，而且 sidebar 可单独定制用于PDF输出的指令。补丁：让-弗朗索瓦·B。和贝尼迪克特·特兰。
#12474：通过CSS支持类型相关的搜索结果突出显示。蒂姆·霍夫曼修补。
#12652：LaTeX：添加 math_numsep 支持乳胶制造商。托马斯·范宁和让-弗朗索瓦·B的补丁。
#12743：当出现第一次警告时，不再退出 --fail-on-warning 采用了相反，如果生成期间生成任何警告，则以非零状态退出。Adam Turner的补丁。
#12743：添加 sphinx-build --exception-on-warning ，在生成期间发出警告时引发异常。Adam Turner和Jeremy Maitin-Shepard的补丁。
#12907：添加 html_last_updated_use_utc 允许使用世界时间（GMT/UTC）而不是本地时间作为提供给的日期时间 html_last_updated_fmt . Adam Turner的补丁。
#12910：版权条目现在支持 '%Y' 替换当前年份的占位符。这有助于减少对Python模块的依赖，例如 time 或 datetime 在 conf.py .看到 the docs 了解更多细节。Adam Turner的补丁。
#11781：添加引用CVS的角色 (:cve: ）和CWE (:cwe: ).雨果·范·凯梅纳德（Hugo van Kemenade）的补丁。
#11809：改进FEC节锚点的格式。补丁由Jakub Stasiak和Adam Turner制作。
#12852：支持 Builder.supported_linkcode 构建器启用使用的属性 sphinx.ext.linkcode - 生成的引用。詹姆斯·奈特的补丁。
#12949：打印与腌制环境不同的配置选项。这有助于诊断全面重建的原因。Adam Turner的补丁。

错误已修复¶

#12514：interphinx：修复负值的含义 intersphinx_cache_limit .由Shengyu Zhang提供补丁。
#12722：LaTeX：避免TeX报告 Overfull \hbox 当问题实际上已经得到解决时，代码线中太长的字符串 verbatimforcewraps .补丁：让-弗朗索瓦·B。
#12730： UnreferencedFootnotesDetector 转换已得到改进，可以更一致地检测未引用的脚注。请注意，转换的优先级已从200更改为622，因此它现在在docutils之后运行 Footnotes 分辨率转换。克里斯·休厄尔（Chris Sewell）的补丁。
#12778：LaTeX：let 'sphinxsetup' div.topic_box-shadow 如果仅与一个维度一起使用，则键根据文档设置x偏置和y偏置。补丁：让-弗朗索瓦·B。
#12587：当Interphinx解析期间检测到潜在的模糊性时，由于不区分大小写的重复目标而出现时，不要发出警告。詹姆斯·艾迪生的补丁。
#12639：修复单数和复数搜索结果文本。雨果·范·凯梅纳德（Hugo van Kemenade）的补丁。
#12645：正确支持自定义gettext输出模板。杰里米·鲍曼的补丁。
#12717: LaTeX: let -q (quiet) option for sphinx-build -M latexpdf or make latexpdf (O=-q) get passed to latexmk. Let -Q (silent) apply as well to the PDF build phase. Patch by Jean-François B.
#12744：LaTeX：由自定义解释文本角色注入的类现在会产生嵌套 \DUrole 的，而不是用逗号分隔的类的单个类。补丁：让-弗朗索瓦·B。
#12831：LaTeX：避免页面底部有时出现的大空隙。补丁：让-弗朗索瓦·B。
#11970，#12551：singlehtml构建器：使目标uri成为相同文档引用 RFC 3986, §4.4 ，例如， index.html#foo 成为 #foo . (note：Sphinx 7.3.0中添加的部分修复的延续）James Addison的补丁（参考Eric Norige之前的工作）。
#12735：修复 PEP 695 通用类LaTeX输出格式。补丁：让-弗朗索瓦·B。和贝尼迪克特·特兰。
#12782：狮身鱼间：修复生成库存文件URL时的双向前斜线（interphinx项目的用户定义的基本URL即使以双向前斜线结束，也不会被修改）。由Bénédikt Tran修补。
#12796：如果需要，启用并行读取，即使文档少于6个。补丁由马蒂亚斯·盖尔（Matthias Geier）制作。
#12844：恢复支持 :noindex: 为 js:module 和 py:module 指令。斯蒂芬·菲纽肯的补丁。
#12916：恢复对以旧命名的自定义模板的支持 _t 后缀期间 apidoc 收件箱渲染（7.4.0中的回归）。詹姆斯·艾迪生的补丁。
#12451：仅用以下值替代版权通知年数 SOURCE_DATE_EPOCH 对于与当前系统时钟年份匹配的条目，并不允许替代未来年份。补丁由詹姆斯·艾迪生和亚当·特纳完成。
#12905：interphinx：修复翻转使用 intersphinx_cache_limit ，它始终为正值保留缓存，并始终为负值刷新缓存。由Nico Madysa修补。
#12888：当文档包含在多个toctree中时添加警告，并通过选择词典上最大的父文档来确保并行构建中全局toctree的确定性解析。由A修补。拉扎尔汗
#12995：在构建中文搜索索引时显著提高性能。Adam Turner的补丁。
#12767： Builder.write() 被定为 final ，这意味着 write-started 事件可以由扩展来依赖。一个新 Builder.write_documents() 方法来控制文档的编写方式。这适用于不为每个文档输出文件的构建器。Adam Turner的补丁。

测试¶

#12141：从废弃的迁移 karma JavaScript测试框架到主动维护的 jasmine 框架. 测试覆盖率不受影响。詹姆斯·艾迪生的补丁。