Sphinx8.2¶

版本8.2.3（2025年3月2日发布）¶

错误已修复¶

#13403：定义 _StrPath.__radd__() . Adam Turner的补丁。
#13399：使用“{c，cpp}：parent_Symbol”修复_ClientDocument成员资格测试。Adam Turner的补丁。

版本8.2.2（2025年3月2日发布）¶

错误已修复¶

#13392：修复参数类型 jieba.load_userdict() .
添加解决办法 nbsphinx 隐性进口。Adam Turner的补丁。
#13402：确保在线 <script/> 标签只写一次。由德米特里·沙赫涅夫和亚当·特纳制作的补丁。
#13391：apidoc：修复TOC文件没有标题的问题。Dave Hoese和Adam Turner的补丁。

版本8.2.1（2025年2月21日发布）¶

错误已修复¶

#13367：正确拼写 highlighting_failure 在警告子类型中。Bart Kamphorst的补丁。
#13377：恢复使用支持 sphinx.testing.path 路径与 sphinx.testing.fixtures .补丁：武井一也。
#13380：viewcode：多次修复导入模块。戴夫·霍伊斯（Dave Hoese）的补丁。
#13382：Napoleon：为配置值使用正确的有效类型。Adam Turner的补丁。
#13376：修复从相对的复制资产 html_static_path 和 html_extra_path 条目亚当·特纳的补丁

版本8.2.0（2025年2月18日发布）¶

依赖关系¶

#13000：放弃Python 3.10支持。

不兼容的更改¶

#13044：删除内部和未记录的 has_equations 的数据 MathDomain 域无证 MathDomain.has_equations() 方法现在无条件返回 True .这些被替换为 has_maths_elements 页面上下文的关键指令。Adam Turner的补丁。
#13227：中键序列的HTML输出 kbd 角色不再使用 <kbd class="kbd compound"> 元素来包装键和分隔符，但将它们直接放置在相关的父节点中。这意味着CSS规则集目标 kbd.compound 或 .kbd.compound 将不再有任何效果。亚当·特纳的补丁

弃用¶

#13037：亵渎 SingleHTMLBuilder.fix_refuris 法詹姆斯·艾迪生的补丁。
#13083、#13330：取消弃用 sphinx.util.import_object .补丁由马蒂亚斯·盖尔（Matthias Geier）制作。

功能添加¶

#13173：添加新的 duplicate_declaration 警告类型，带有 duplicate_declaration.c 和 duplicate_declaration.cpp 亚型。由Julien Lecomte和Adam Turner制作的补丁。
#11824：linkcode：允许扩展通过定义应该存在的键来添加对域的支持。尼古拉斯·皮格纳特（Nicolas Peugnet）的补丁。
#13144：添加 class 选项到 autosummary 指令。蒂姆·霍夫曼修补。
#13146：Napoleon：统一类型预处理逻辑，允许Google风格的文档字符串使用可选和默认关键字。克里斯·巴里克的补丁。
#13227：实施 kbd 作用 SphinxRole . Adam Turner的补丁。
#13065：在CI上运行时默认启用颜色。亚当·特纳的补丁
#13230：允许压制来自 toctree 当glob模式不匹配任何文档时，通过新的 toc.empty_glob 警告子类型。Slawek Figiel的补丁。
#9732：添加新的 autodoc.mocked_object 警告子类型。西里尔·罗兰德（Cyril Roelandt）的补丁。
#7630、#4824：autodoc：使用 .pyi 输入树桩文件以自动记录本地模块。Adam Turner的补丁，部分基于Allie Fitter的工作。
#12975：通过新的 python_trailing_comma_in_multi_line_signatures 和 javascript_trailing_comma_in_multi_line_signatures 配置选项。
#13264：删除 math 指令的 nowrap 选项 math:no-wrap . Adam Turner的补丁。
#13269：添加了通过新的禁用类型评论的选项 autodoc_use_type_comments 选项，默认为 True 用于向后兼容性。默认值将更改为 False 狮身克斯10。亚当·特纳的补丁
#9732：添加新的 ref.any 警告子类型允许抑制模棱两可的“任何”交叉引用警告。Simão Afonso和Adam Turner的补丁。
#13272：Python和JavaScript模块指令现在支持 :no-index-entry: 选项. Adam Turner的补丁。
#12233：autodoc：允许使用指令 :no-index-entry: 并包括 :no-index: 和 :no-index-entry: 内的选项 autodoc_default_options . Jonny Saunders和Adam Turner的补丁。
#13172：在自动摘要中添加对短签名的支持。蒂姆·霍夫曼修补。
#13271：将Python域中抽象方法的签名前置更改为 abstractmethod 从 abstract . Adam Turner的补丁。
#13271：支持 :abstract: Python域中的类、方法和属性的选项。Adam Turner的补丁。
#12507：添加 collapsible 警告指令的选项。克里斯·休厄尔（Chris Sewell）的补丁。
#8191、#8159：添加 inheritance-diagram:include-subclasses 选项到 inheritance-diagram 指令。沃尔特·德尔瓦尔德（Walter Dörwald）补丁。
#11995：autodoc：添加支持 python_display_short_literal_types .补丁由Bénédikt Tran和Adam Turner制作。
#13163：当Sphinx遇到内部错误时，始终打印完整上下文。补丁由Kevin Deldycke和Adam Turner制作。
#13105：介绍 py:deco 交叉引用Python域中的装饰器函数和方法的角色。Adam Turner的补丁。
#9169：添加 intersphinx_resolve_self 用于解析对当前项目的interphinx引用的选项。由Jakob Lykke Andersen和Adam Turner制作。
#11280：添加使用跳过特定部分的功能 no-search 课威尔·拉钱斯（Will Lachance）的补丁。
#13326：从处理中删除硬编码 productionlist 所有写入器中的节点，以提高灵活性。Adam Turner的补丁。
#13335：使用 misc.highlighting_failure Pygments未知lexer的子类型。Bart Kamphorst的补丁。
#13354：在Python签名中插入仅位置分隔符和关键字分隔符的缩写节点（悬停文本）。Adam Turner的补丁。
#13333：添加 sphinx.ext.apidoc 扩展，可以自动从Python模块生成API文档。克里斯·休厄尔（Chris Sewell）和亚当·特纳（Adam Turner）的补丁。

错误已修复¶

#12463：自动摘要：尊重空模块 __all__ .瓦伦丁·普拉茨的补丁
#13060：HTML搜索：使用 Map 以存储每个档案的学期分数。詹姆斯·艾迪生的补丁
#13130：LaTeX文档： pdflatex 法语索引条目的索引创建可能会失败。看到 latex_use_xindy .补丁：让-弗朗索瓦·B。
#13152：LaTeX：修复v7.4.0默认的打字错误 \sphinxboxsetup .补丁：让-弗朗索瓦·B。
#13096：HTML搜索：在访问查询项之前，检查查询项是否作为属性存在于项索引中。
#11233：linkcheck：匹配重定向uri linkcheck_ignore 通过覆盖会话级别 requests.get_redirect_target .
#13195：viewcode：修复导入路径与目录结构不同的问题。本·伊根（Ben Egan）和亚当·特纳（Adam Turner）的补丁。
#13188：autodoc：修复C中实现的类方法的检测。由Bénédikt Tran修补。
#1810：构建时始终复制静态文件，无论自上次构建以来是否有任何文档发生更改。Adam Turner的补丁。
#13201：autodoc：修复使用时成员的顺序 groupwise 为 autodoc_member_order .类方法现在在静态方法之前呈现，静态方法本身在常规方法和属性之前呈现。由Bénédikt Tran修补。
#12975：避免在C和C++多行签名中呈现尾部逗号。
#13178：autodoc：修复分辨率 pathlib 类型Adam Turner的补丁。
#13136：autodoc：正确处理多重继承。Pavel Holica的补丁
#13273、#13318：正确转换布尔类型的命令行重写。Adam Turner的补丁。
#13302、#13319：中的继续行使用正确的折痕 productionlist 指令。Adam Turner的补丁。
#13328：修复带有返回注释的PEP 695函数的解析。由Bénédikt Tran修补。Arash Badie-Modiri的初步作品。

测试¶

#13224：正确修复 test_html_multi_line_copyright .补丁由Colin Watson制作，由James Addison应用。