Sphinx 4.2

版本 4.2.0 (发布于 2021 年 9 月 12 日)

新增功能

  • #9445: autodoc: 支持类属性

  • #9479: autodoc: 如果目标是 mocked 对象，则发出警告

  • #9560: autodoc: 允许在 Python 3.10 或更高版本中使用模块名称引用 NewType 实例

  • #9447: html theme: 以元组形式将 Sphinx 版本作为模板变量 sphinx_version_tuple 暴露

  • #9594: manpage: 如果描述为空，则抑制手册页的标题

  • #9445: py domain: py:property 指令支持 :classmethod: 选项来描述类属性

  • #9524: test: SphinxTestApp 可以将 builddir 作为参数

  • #9535: C 和 C++：支持更多基本类型，包括 GNU 扩展。

修复的 Bug

  • #9608: apidoc: apidoc 不会为隐式命名空间包生成模块定义

  • #9504: autodoc: 如果目标类继承了具有 _name 属性的类，则生成对父类的错误引用

  • #9537, #9589: autodoc: typing 模块下的某些对象在 3.10 的 HEAD 版本中显示不佳

  • #9487: autodoc: cached_property 的类型提示未显示

  • #9509: autodoc: 在解析类型提示失败时引发 AttributeError

  • #9518: autodoc: autodoc_docstring_signature 不影响 __init__() 和 __new__()

  • #9522: autodoc: 带有参数的 PEP 585 样式类型提示（例如 list[int]）显示不佳

  • #9481: autosummary: 某些警告包含不存在的文件名

  • #9568: autosummary: 正确汇总带有上划线的章节标题

  • #9600: autosummary: autosummary 表中包含逗号的类型注解未完全删除

  • #9481: c domain: 某些警告包含不存在的文件名

  • #9481: cpp domain: 某些警告包含不存在的文件名

  • #9456: html search: 如果无法获取页面内容，则搜索结果中会插入省略标记

  • #9617: html search: 如果浏览器速度慢，会显示 JS 要求警告

  • #9267: html theme: 主题添加的 CSS 和 JS 文件被加载了两次

  • #9585: py domain: py:property 指令的 :type: 选项不创建超链接

  • #9576: py domain: 字面量类型提示被转换为交叉引用

  • #9535 comment: C++：修复了默认函数参数为函数指针的解析问题。

  • #9564: smartquotes: 不要为带有语言高亮的 :code: 角色文本调整排版。

  • #9512: sphinx-build: 在 Python 3.10 的 HEAD 版本中崩溃