Sphinx 8.0

发布 8.0.2（发布于 2024 年 7 月 30 日）

修复的 Bug

  • 修复 pygments.Formatter.__class_getitem__ 补丁。补丁由 Adam Turner 提供。

发布 8.0.1（发布于 2024 年 7 月 30 日）

修复的 Bug

  • 在 Pygments 2.17 中修补 pygments.Formatter.__class_getitem__。补丁由 Adam Turner 提供。

发布 8.0.0（发布于 2024 年 7 月 29 日）

依赖项

  • #12633：停止支持 Python 3.9。

不兼容的变更

  • 从 sphinx.util 中删除已弃用的函数

    • 已删除 sphinx.util.path_stabilize（请使用 sphinx.util.osutil.path_stabilize）。

    • 已删除 sphinx.util.display_chunk（请使用 sphinx.util.display.display_chunk）。

    • 已删除 sphinx.util.status_iterator（请使用 sphinx.util.display.status_iterator）。

    • 已删除 sphinx.util.SkipProgressMessage（请使用 sphinx.util.display.SkipProgressMessage）。

    • 已删除 sphinx.util.progress_message（请使用 sphinx.util.display.progress_message）。

    • 已删除 sphinx.util.epoch_to_rfc1123（请使用 sphinx.http_date.epoch_to_rfc1123）。

    • 已删除 sphinx.util.rfc1123_to_epoch（请使用 sphinx.http_date.rfc1123_to_epoch）。

    • 已删除 sphinx.util.save_traceback（请使用 sphinx.exceptions.save_traceback）。

    • 已删除 sphinx.util.format_exception_cut_frames（请使用 sphinx.exceptions.format_exception_cut_frames）。

    • 已删除 sphinx.util.xmlname_checker（请使用 sphinx.builders.epub3._XML_NAME_PATTERN）。

    补丁由 Adam Turner 提供。

  • 已删除 sphinx.util.osutil.cd()（请使用 contextlib.chdir()）。补丁由 Adam Turner 提供。

  • 已删除 sphinx.util.typing.stringify()（请使用 sphinx.util.typing.stringify_annotation()）。补丁由 Adam Turner 提供。

  • #12593：对无效的 html_sidebars 值引发错误。补丁由 Adam Turner 提供。

  • #12593：在 Theme.get_config() 中对无效的部分引发错误。补丁由 Adam Turner 提供。

  • #11693：在 sphinx-quickstart 中删除对旧式 Makefile 和 make.bat 输出的支持。

  • #11693：从 sphinx-quickstart 中删除 --no-use-make-mode、-M、--use-make-mode 和 -m 选项。补丁由 Adam Turner 提供。

  • 已删除 sphinx.ext.autodoc.ObjectMember 的元组接口。补丁由 Adam Turner 提供。

  • #12630：Sphinx 8 对 linkcheck 配置默认值做了两项更改

    补丁由 James Addison 提供。

  • #12597：将 show_warning_types 的默认值从 False 更改为 True。补丁由 Chris Sewell 提供。

  • #12083：删除对旧（2008-2010）Sphinx 0.5 和 Sphinx 0.6 intersphinx_mapping 格式的支持。补丁由 Bénédikt Tran 和 Adam Turner 提供。

  • #12096：复制资产时，除非强制使用 force=True，否则不要覆盖用户提供的文件。补丁由 Adam Turner 提供。

  • #12646：删除 sphinx.util.inspect.isNewType()。在 Python 3.10 及更高版本上，请改用 isinstance(obj, typing.NewType)。补丁由 Adam Turner 提供。

  • 删除 sphinx.directives.other 中已长期弃用（自 Sphinx 2 起）的 VersionChange 别名（自 Sphinx 2 起弃用）。直接使用 sphinx.domains.changeset.VersionChange。补丁由 Adam Turner 提供。

已弃用

  • #12643：将 sphinx.ext.intersphinx.normalize_intersphinx_mapping 重命名为 sphinx.ext.intersphinx.validate_intersphinx_mapping。旧名称将在 Sphinx 10 中删除。补丁由 Adam Turner 提供。

  • #12650、#12686、#12690：将 Path 对象的字符串方法的弃用扩展到 Sphinx 9。使用 os.fspath() 将 Path 对象转换为字符串，或使用 Path 的方法来处理路径对象。补丁由 Adam Turner 提供。