Sphinx 6.1

版本 6.1.3 (发布于 2023 年 1 月 10 日)

修复的 Bug

  • #11116: 恢复到以前的 Sphinx 5 节点复制方法

  • #11117: 恢复了 Sphinx 6.1.0 中并行图像处理的更改

  • #11119: 在 linkcheck 构建器中抑制 ValueError

版本 6.1.2 (发布于 2023 年 1 月 7 日)

修复的 Bug

  • #11101: LaTeX: sphinxsetup 的 div.topic_padding 键在 5.1.0 中被记录,但以名称 topic_padding 实现

  • #11099: LaTeX: sphinxsetup 的 shadowrule 键自 Sphinx 5.1.0 以来导致 PDF 构建崩溃

  • #11096: LaTeX: sphinxsetup 的 shadowsize 键自 Sphinx 5.1.0 以来导致 PDF 构建崩溃

  • #11095: LaTeX: 自 Sphinx 5.1.0 以来,主题目录框的阴影不在页面边距内

  • #11100: 修复在并行模式下运行时的图像复制问题。

版本 6.1.1 (发布于 2023 年 1 月 5 日)

修复的 Bug

  • #11091: 修复 util.nodes.apply_source_workaround 对于节点或其父节点中没有源信息的 literal_block 节点。

版本 6.1.0 (发布于 2023 年 1 月 5 日)

依赖项

  • 采用了 Ruff 代码检查器。

不兼容的变更

  • #10979: gettext: 移除了对 get_translation 中复数化的支持。这未被使用,并使 sphinx.locale 的其他更改复杂化。

已弃用

  • sphinx.util 函数

    • sphinx.util.typing.stringify() 重命名为 sphinx.util.typing.stringify_annotation()

    • sphinx.util.xmlname_checker() 移动到 sphinx.builders.epub3._XML_NAME_PATTERN

    移动到 sphinx.util.display

    • sphinx.util.status_iterator

    • sphinx.util.display_chunk

    • sphinx.util.SkipProgressMessage

    • sphinx.util.progress_message

    移动到 sphinx.util.http_date

    • sphinx.util.epoch_to_rfc1123

    • sphinx.util.rfc1123_to_epoch

    移动到 sphinx.util.exceptions

    • sphinx.util.save_traceback

    • sphinx.util.format_exception_cut_frames

新增功能

  • 在写入阶段缓存构建环境中的文档树。

  • 使所有写入阶段任务支持并行执行。

  • #11072: 在 Python 域和 autodoc 中,对 typing.Optionaltyping.Optional 类型使用 PEP 604 (X | Y) 显示约定。

  • #10700: autodoc: 将 typing.NewType() 类型记录为类而不是“数据”。

  • 在读取和写入阶段之间缓存文档树。

修复的 Bug

  • #10962: HTML: 修复多词键名查找表。

  • 修复了对 Python 3.12 alpha 3 的支持(enum 模块中的更改)。

  • #11069: HTML 主题: 移除了过时的“快捷方式”链接关系关键字。

  • #10952: 在程序中断时正确终止并行进程。

  • #10988: 通过更高效的复制来加快 TocTree.resolve() 的速度。

  • #6744: LaTeX: seealso 指令的支持应通过环境实现,以允许样式设置。

  • #11074: LaTeX: 从 5.1.0 开始无法将 sphinxnote 更改为使用 sphinxheavybox