Sphinx 8.0

版本 8.0.2(发布于 2024 年 7 月 30 日)

修复的错误

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

发行版 8.0.1(发布于 2024年7月30日)

修复的错误

  • 修补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: 移除对老式 Makefilemake.bat 输出的支持,在 sphinx-quickstart 中.

  • #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.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 提供.