Sphinx 7.2¶

版本 7.2.6（发布于 2023 年 9 月 13 日）¶

#11679: 添加 SPHINX_AUTODOC_RELOAD_MODULES 环境变量,如果设置则在使用带 TYPE_CHECKING = True 的autodoc时重新加载模块.补丁由 Matt Wozniski 和 Adam Turner 提供.
#11679: 使用 importlib.reload() 重新加载自动文档中的模块.补丁由 Matt Wozniski 和 Adam Turner 提供.

#11645: 修复了一个回归问题,该问题阻止了autodoc在包内导入使用 if typing.TYPE_CHECKING: 保护类型检查器所需的循环导入的模块.补丁由Matt Wozniski提供.
#11634:修复了子目录中兄弟文件的继承图相对链接解析.补丁由Albert Shih提供.
#11659: 允许在 mathjax_path 中使用 ?config=... .
#11654: autodoc: 当一个对象声称是 type 的实例但不是类时,失败时给出更具描述性的错误信息.补丁由 James Braza 提供.
11620: 停止为通过 include 指令读取的文件发出 source-read 事件.
11620:添加一个新的:event:include-read ,用于通过:dudir:include 指令观察和转换被包含文件的内容.
#11627: 当设置了 SOURCE_DATE_EPOCH 时,恢复对 YYYY 形式版权行的支持.

#11618:修复在 #10478 引入的 MoveModuleTargets 转换中的回归问题 (#9662).
#11649: linkcheck: 解决位于伦敦以西的时区挂起测试以及从UTC到UNIX纪元偏移量的不正确转换.补丁由Dmitry Shachnev和Adam Turner提供.

修复 autodoc.Documenter.parse_name() 的回归问题.
修复JSON序列化中的回归问题.
#11543: autodoc: 当 autodoc_preserve_defaults 为 True 时,在 classmethod 方法中支持位置参数.
恢复路径对象上的字符串方法支持.这已被弃用,并将在 Sphinx 8 中移除.使用 os.fspath() 将 Path 对象转换为字符串,或使用 Path 的方法处理路径对象.

修复 StateMachine.insert_input() 补丁的签名,以便在使用关键字参数调用时.
修复了资产类的 str 接口的成员测试（ in ）,而某些扩展依赖于此（ _CascadingStyleSheet 和 _JavaScript ）.
修复了 SingleFileHTMLBuilder._get_local_toctree 中的类型错误, includehidden 可以作为字符串或布尔值传递.
修复 :noindex: 对于 PyModule 和 JSModule .

恢复了资产类(str 接口（ _CascadingStyleSheet 和 _JavaScript ）,一些扩展依赖于此.此功能将在Sphinx 9中移除.
恢复了对 Builder.add_{css,js}_file() 的调用,多个扩展依赖于此.
恢复了私有 API TocTree.get_toctree_ancestors() ,多个扩展依赖于此.

#11512: 淘汰 sphinx.util.md5 和 sphinx.util.sha1 .请改用 hashlib .
#11526: 弃用 sphinx.testing.path .请改用 os.path 或 pathlib .
#11528: 废弃 sphinx.util.split_index_msg 和 sphinx.util.split_into .请改用 sphinx.util.index_entries.split_index_msg .
弃用 sphinx.builders.html.Stylesheet 和 sphinx.builders.html.Javascript .请使用 sphinx.application.Sphinx.add_css_file() 和 sphinx.application.Sphinx.add_js_file() 代替.
#11582: 废弃 sphinx.builders.html.StandaloneHTMLBuilder.css_files 和 sphinx.builders.html.StandaloneHTMLBuilder.script_files .请改用 sphinx.application.Sphinx.add_css_file() 和 sphinx.application.Sphinx.add_js_file() .
#11459: 废弃 sphinx.ext.autodoc.preserve_defaults.get_function_def() .补丁由 Bénédikt Tran 提供.

#11526: 在更多地方支持 os.PathLike 类型和 pathlib.Path 对象.
#5474: 覆盖率:打印摘要统计表.补丁由Jorge Leitao提供.
#6319: viewcode: 添加 viewcode_line_numbers 以控制是否在渲染的源代码中添加行号.补丁由 Ben Krikler 提供.
#9662: 添加 :no-typesetting: 选项以抑制文本输出,仅创建一个可链接的锚点.补丁由 Latosha Maltba 提供.
#11221: C++: 在目录中支持域对象.补丁由Rouslan Korneychuk提供.
#10938: doctest: 添加 doctest_show_successes 选项.补丁由 Trey Hunner 提供.
#11533: 添加 :no-index: , :no-index-entry: , 和 :no-contents-entry: .
#11572: 改进 debug 日志,记录文件被检测为过时的原因.补丁由 Eric Larson 提供.
#10678: 为通过 include 指令读取的文件发出 source-read 事件.补丁由 Halldor Fannar 提供.
#11570: 在使用 PEP 585 内置通用类型时使用简短名称.补丁由 Riccardo Mori 提供.
#11300: 改进 SigElementFallbackTransform 的回退逻辑和签名文本元素节点.有关更多详细信息,请参见文档 .补丁由 Bénédikt Tran 提供.
允许使用 python -m sphinx build ... 运行 Sphinx.

#11077: graphviz: 修复图中的相对链接.补丁由 Ralf Grubenmann 提供.
#11529: LaTeX生成器中的行块输出多余的空标记.补丁由Adrian Vollmer提供.
#11196: autosummary: 摘要行提取失败,出现”例如”
#10614: 修复了继承图中的多个错误,导致链接缺失或损坏.补丁由Albert Shih提供.
#9428: 在运行 gettext 构建器时排除替换定义.补丁由 Alvin Wong 提供.
#10795: 如果 graphviz_dot 为假,则引发描述性错误.
#11546: 与其原始文本相同的翻译节点现在标记为 translated=True 属性.
#10049: html: 将链接锚点中的标题文本 “Permalink” 改为 “Link”.
#4225: 在词法分析失败时放宽Pygments解析.
#11246: 在文档字符串的第一行和使用 sphinx.ext.napoleon 时的单行类型注释 #: :meta ...: 中允许使用内联链接.补丁由 Bénédikt Tran 提供.
#10930: 在搜索结果页面高亮所有搜索词.补丁由Dmitry Shachnev提供.
#11473: 包含 Literal 枚举值的类型注解现在能够正确渲染.补丁由 Bénédikt Tran 提供.
#11591: 修复 sphinx.ext.coverage 扩展中对 C 覆盖率的支持.补丁由 Stephen Finucane 提供.
#11594: HTML主题:对 agogo 主题在较小设备上的横向滚动进行了增强.补丁由Lukas Engelter提供.
#11459: 修复 sphinx.ext.autodoc.preserve_defaults 中对异步和lambda函数的支持.补丁由Bénédikt Tran提供.