Sphinx5.0¶
版本5.0.2（2022年6月17日发布）¶
功能添加¶
#10523：HTML主题：将Docutils的版本信息数组公开为模板变量，
docutils_version_info. Adam Turner的补丁。
错误已修复¶
#10538：autodoc：即使即使是，具有doc字符串的继承类属性也会被记录
autodoc_inherit_docstring被禁用#10509：自动摘要：共享库的自动摘要失败
#10497：py域：无法解析Literal中的字符串。Adam Turner的补丁。
#10523：HTML主题：修复Docutils 0.18+中引用的双括号。Adam Turner的补丁。
#10534：Docutils 0.18+中导航内容缺少CSS。Adam Turner的补丁。
版本5.0.1（2022年6月3日发布）¶
错误已修复¶
版本5.0.0（2022年5月30日发布）¶
依赖关系¶
5.0.0 b1
#10164：支持 Docutils 0.18 . Adam Turner的补丁。
不兼容的更改¶
5.0.0 b1
#10031：自动摘要：
sphinx.ext.autosummary.import_by_name()现在提高ImportExceptionGroup而不是ImportError当导入目标对象失败时。 如果您的扩展使用该函数导入Python对象，请处理异常。 作为解决办法，您可以通过以下方式禁用该行为grouped_exception=Falsev7.0之前的关键字参数。#9962：texinfo：通过自定义强调文本的样式
@definfoenclose不支持该命令，因为自texinfo 6.8以来已弃用该命令#2068：
intersphinx_disabled_reftypes已将默认值从空列表更改为['std:doc']以避免过于令人惊讶的无声狮身识别决议。要迁移：要么将显式的库存名称添加到interphinx应该解析的引用中，要么显式地将此配置变量的值设置为空列表。#10197：HTML主题：Reduce
body_min_width基本主题设置为360 px#9999：LaTeX：通过CR将术语与其定义分开（参考文献：#9985）
#10062：将默认语言更改为
'en'如果没有设置任何语言，conf.py
5.0.0决赛
#10474：
language不接受None因为它的价值。 的默认值language变为'en'现在Adam Turner和Takeshi KOMIYA补丁。
弃用¶
5.0.0 b1
#10028：jQuery和underscore.js将不再自动注入Sphinx 6.0的主题。如果您开发的主题或扩展使用
jQuery,$，或者$u全局对象，您需要更新JavaScript或使用下面的缓解措施。要重新添加jQuery和underscore.js，您需要复制
jquery.js和underscore.js从 the Sphinx repository 到您static目录，并将以下内容添加到您的layout.html:{%- block scripts %} <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script> <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script> {{ super() }} {%- endblock %}
Adam Turner的补丁。
setuptools集成。 的
build_sphinxsetup.py的子命令被标记为不建议使用，以遵循setuptools团队的政策。的
locale论点sphinx.util.i18n:babel_format_date()成为必需的的
language论点sphinx.util.i18n:format_date()成为必需的sphinx.builders.html.html5_readysphinx.io.read_doc()sphinx.util.docutils.__version_info__sphinx.util.docutils.is_html5_writer_available()sphinx.writers.latex.LaTeXWriter.docclasses
功能添加¶
5.0.0 b1
#9075：autodoc：的默认值
autodoc_typehints_format被改变为'smart'. 它将隐藏typehints的主要模块名称（例如。io.StringIO->StringIO).#8417：autodoc：
:inherited-members:选项现在需要多个类别。 它允许通过指定选项来同时抑制模块上多个类的继承成员automodule指令#9792：autodoc：添加新选项
autodoc_typehints_description_target包括未记录的返回值，但不包括未记录的参数。#10285：autodoc：singledispatch函数没有记录类型提示
autodoc：
autodoc_typehints_format现在还适用于属性、数据、属性和类型变量边界。#10258：自动摘要：将模块的文档属性识别为非导入
#10028：删除了JavaScript框架（jQuery和undersscore.js）的内部使用并进行了现代化
doctools.js和searchtools.jsEMCAScript 2018 Adam Turner的补丁。#10302：C++，添加对条件表达式的支持 (
?:).#5157，#10251：内联代码可以通过 role 指令
#10337：通过在构建过程中缓存Publisher对象，使sphinx构建更快。Adam Turner的补丁。
错误已修复¶
5.0.0 b1
#10200：apidoc：对于同时具有.pyx和.so文件的模块，显示了重复的子模块。Adam Turner和Takeshi KOMIYA补丁。
#10279：autodoc：重载函数中仅关键字参数的默认值呈现为字符串字面量
#10280：autodoc：
autodoc_docstring_signature如果文档字符串具有多个签名，则意外地为构造函数生成返回值typehint#10266：autodoc：
autodoc_preserve_defaults不适用于只包含关键字参数（带/不带默认值）的混合#10310：autodoc：当用被模仿的函数装饰时，不会记录类方法
#10305：autodoc：未能通过正确提取可选的正向引用类型提示
autodoc_type_aliases#10421：autodoc：
autodoc_preserve_defaults不适用于类方法#10214：html：如果出现以下情况，则生成无效语言标签
language包含国家代码（例如。zh_CN）#9974：html：将jQuery版本从3.5.1更新到3.6.0
#10236：html搜索：搜索结果中对象重复
#9962：texinfo：废弃消息
@definfoenclose构建texinfo文档的命令#10000：LaTeX：具有通用定义的术语表术语呈现了太多垂直空白
#10188：LaTeX：交替多重引用脚注产生
?pdf输出#10363：LaTeX：制造
'howto'标题页规则使用\linewidth为了与twocolumn类选项#10318：
:prepend:选择literalinclude指令不适用于:dedent:选项
5.0.0决赛
#9575：autodoc：当时，不应显示返回值的注释
autodoc_typehints="description"#9648：autodoc：
*args和**kwargs当autodoc_typehints="description"#8180：autodoc：属性被忽略的Doc字符串元数据
#10443：epub：EPub构建器无法检测.webp文件的mimetype
#10104：gettext：如果第三方扩展未提供正确信息，则显示重复位置
#10456：py域：
:meta:如果文档字符串包含两个或多个元字段，则显示字段#9096：sphinx-build：并行构建的进度条值错误
#10110：phinx-Build：当生成器完成的事件中引发错误时，退出代码不会更改