Sphinx8.0

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

错误已修复

  • 固定 pygments.Formatter.__class_getitem__ 补丁. Adam Turner的补丁。

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

错误已修复

  • 贴片 pygments.Formatter.__class_getitem__ 在Pygments 2.17中。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 价值观亚当·特纳的补丁

  • #12593:提出错误 Theme.get_config() 对于无效部分。亚当·特纳的补丁

  • #11693:删除对老式的支持 Makefilemake.bat 输出 sphinx-quickstart .

  • #11693:删除 --no-use-make-mode , -M , --use-make-mode ,而且 -m 选项从 sphinx-quickstart . Adam Turner的补丁。

  • 删除了元组接口, sphinx.ext.autodoc.ObjectMember . Adam Turner的补丁。

  • #12630:Sphinx8对 linkcheck 配置默认值:

    詹姆斯·艾迪生的补丁。

  • #12597:更改的默认值 show_warning_typesFalseTrue .克里斯·休厄尔(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() .使用 isinstance(obj, typing.NewType) 而是在Python 3.10及更新版本上。亚当·特纳的补丁

  • 删除长期废弃的(自Sphinx 2以来)别名,以 VersionChangesphinx.directives.other (自狮身X 2以来已废弃)。使用 sphinx.domains.changeset.VersionChange 直接. Adam Turner的补丁。

弃用

  • #12643:更名 sphinx.ext.intersphinx.normalize_intersphinx_mappingsphinx.ext.intersphinx.validate_intersphinx_mapping .旧名称将在Sphinx10中被删除。Adam Turner的补丁。

  • #12650、#12686、#12690:扩展字符串方法的弃用 Path 反对狮身克斯9号。使用 os.fspath() 转换 Path 对象到字符串,或者 Path 的处理路径对象的方法。Adam Turner的补丁。