Sphinx 5.0¶

版本 5.0.2（发布于 2022年6月17日）¶

#10523: HTML主题:将Docutils的版本信息元组公开为模板变量 docutils_version_info .补丁由Adam Turner提供.

5.0.0 b1

5.0.0 b1

#10031: autosummary:sphinx.ext.autosummary.import_by_name() 现在会在无法导入目标对象时引发 ImportExceptionGroup 而不是 ImportError .如果您的扩展使用该函数导入 Python 对象,请处理此异常.作为一种解决方法,您可以在 v7.0 之前通过 grouped_exception=False 关键字参数禁用此行为.
#9962: texinfo: 由于 @definfoenclose 命令自 texinfo 6.8 起被弃用,因此不支持通过该命令自定义强调文本的样式
#2068: intersphinx_disabled_reftypes 的默认值已从空列表更改为 ['std:doc'] ,以避免过于令人惊讶的静默 intersphinx 解析.要迁移:要么为 intersphinx 应解析的引用添加显式的清单名称,要么显式将该配置变量的值设置为空列表.
#10197: html 主题: 将基本主题中的 body_min_width 设置减少到 360px
#9999: LaTeX: 用换行符将术语与其定义分开 (参考: #9985)
#10062: 如果在 conf.py 中未设置任何语言,则将默认语言更改为 'en'

5.0.0 最终版

#10474: language 不接受 None 作为值. language 的默认值现在变为 'en' .补丁由 Adam Turner 和小宫武志提供.

5.0.0 b1

#10028: 从 Sphinx 6.0 开始,jQuery 和 underscore.js 将不再自动注入到主题中.如果您开发的主题或扩展使用了 jQuery 、 $ 或 $u 全局对象,您需要更新您的 JavaScript 或使用下面的缓解措施.

要重新添加 jQuery 和 underscore.js,您需要将 jquery.js 和 underscore.js 从 Sphinx 仓库复制到您的 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 %}
```
补丁由亚当·特纳提供.
setuptools 集成.setup.py 的 build_sphinx 子命令被标记为不推荐使用,以遵循 setuptools 团队的政策.
The locale argument of sphinx.util.i18n:babel_format_date() becomes required
The language argument of sphinx.util.i18n:format_date() becomes required
sphinx.builders.html.html5_ready
sphinx.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' .它将抑制类型提示的前导模块名称（例如 io.StringIO -> StringIO ）.
#8417: autodoc::inherited-members: 选项现在可以接受多个类.通过将此选项指定给 automodule 指令,可以一次性抑制模块中多个类的继承成员
#9792: autodoc: 为 autodoc_typehints_description_target 添加新选项,以包含未记录的返回值,但不包括未记录的参数.
#10285: autodoc: 带有类型提示的 singledispatch 函数未被文档化
autodoc: autodoc_typehints_format 现在也适用于属性、数据、属性和类型变量的界限.
#10258: autosummary: 识别模块的已记录属性为未导入的
#10028: 移除了对JavaScript框架（jQuery和underscore.js）的内部使用,并将 doctools.js 和 searchtools.js 现代化为ECMAScript 2018.补丁由Adam Turner提供.
#10302: C++,增加对条件表达式 ( ?: ) 的支持.
#5157,#10251:内联代码可以通过 role 指令进行高亮
#10337: 通过在构建过程中缓存 Publisher 对象来加快 sphinx-build 的速度.补丁由 Adam Turner 提供.

5.0.0 b1

#10200: apidoc: 对于同时具有 .pyx 和 .so 文件的模块,显示了重复的子模块.补丁由 Adam Turner 和 Takeshi KOMIYA 提供.
#10279: autodoc: 重载函数中仅关键字参数的默认值作为字符串字面值呈现
#10280: autodoc: autodoc_docstring_signature 意外地为构造函数生成返回值类型提示,如果文档字符串具有多个签名
#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: 在构建texinfo文档时对 @definfoenclose 命令的弃用消息
#10000: LaTeX: 共通定义的词汇条目渲染时垂直空白过多
#10188: LaTeX: 交替多次引用的脚注在pdf输出中产生 ?
#10363: LaTeX: 使 'howto' 标题页规则使用 \linewidth 以便与 twocolumn 类选项的使用兼容
#10318::prepend: 选项在 literalinclude 指令中与 :dedent: 选项不兼容

5.0.0 最终版