Sphinx 4.4

发布 4.4.0（发布日期:2022年1月17日）

依赖项

  • #10007: 对于 Python 3.9 或更早版本使用 importlib_metadata

  • #10007: 删除 setuptools

添加的功能

  • #9075: autodoc: 添加一个配置变量 autodoc_typehints_format ,以抑制函数签名中的类型提示的前导模块名称（例如 io.StringIO -> StringIO ）

  • #9831: 当 autosummary_ignore_module_all 设置为 False 时,Autosummary 现在仅记录模块 __all__ 属性中指定的成员.默认行为保持不变.Autogen 现在也支持这种行为,使用 --respect-module-all 开关.

  • #9555: autosummary: 改进无法加载目标对象时的错误消息

  • #9800: extlinks: 如果硬编码的链接可以被extlink替换,则发出警告,建议进行替换.

  • #9961: html: 支持在其他HTML构建器中嵌套<kbd> HTML元素

  • #10013: html: 允许通过 loading_method 参数更改 Sphinx.add_js_file() 的 JS 加载方式

  • #9551: html 搜索:”隐藏搜索匹配”链接从 URL 中移除了 “highlight” 参数

  • #9815: html主题:将侧边栏组件包装在div中,以便通过CSS自定义其布局

  • #9827: i18n: 根据翻译条款对术语表中的项目进行排序

  • #9899: py 域:允许将交叉引用说明符（ . 和 ~ ）作为 :type: 选项指定

  • #9894: linkcheck: 添加选项 linkcheck_exclude_documents 以禁用在匹配文档中的链接检查.

  • #9793: sphinx-build: 允许在macOS和Python3.8+上使用并行构建功能

  • #10055: sphinx-build: 当给定 -w 选项时创建目录

  • #9993: 标准领域:允许通过 ref 角色引用内联目标（例如``_`目标名称```）

  • #9981: 标准域:从通用索引中删除选项指令的值部分

  • #9391: texinfo: 改进 samp 角色中的变量

  • #9578: texinfo: 添加 texinfo_cross_references 以禁用独立阅读器的可读性交叉引用

  • #9822, #9062: 添加新的 Intersphinx 角色 external ,用于在外部项目中进行显式查找,而不解析到本地项目.

修复的错误

  • #9866:autodoc:导入类的文档注释被忽略

  • #9883:autodoc:对被模拟对象别名的文档注释被忽略

  • #9908: autodoc: 在使用 Python 3.10 的 NewTypes 构建文档时显示调试信息

  • #9968: autodoc: 如果 __init__ 方法有位置仅参数,则实例变量不显示

  • #9194: autodoc: “typing” 模块下的类型没有超链接

  • #10009: autodoc: 如果目标对象在获取文档字符串时引发错误,则崩溃

  • #10058: autosummary: 当 autodoc_class_signature = 'separated' 时,导入的成员未显示

  • #9947: i18n: 主题指令包含项目符号列表无法翻译

  • #9878: mathjax: MathJax配置在加载MathJax本身之后放置

  • #9932: napoleon: 即使没有描述,仍然生成空的 “返回值” 部分

  • #9857: 生成的RFC链接使用过时的基本URL

  • #9909: HTML,防止在文字中换行.

  • #10061: html 主题:由主题添加的配置值无法在 conf.py 中被覆盖

  • #10073: imgconverter: 对 “data” URI 调用的不必要的可用性检查

  • #9925: LaTeX:禁止在内联和解析文本的破折号处进行 'xelatex' 换行

  • #9944: LaTeX: 某些嵌套声明的额外垂直空白

  • #9940: LaTeX:Python 领域中的多功能声明在 latexpdf 输出中垂直间距过于紧凑

  • #10015: py 域:位于 “typing” 模块下的类型没有超链接,定义在 info-field-list

  • #9390: texinfo: 不要在脚注中发出标签

  • #9413: xml: 交叉引用Python对象时生成了无效的XML

  • #9979:错误级别消息被显示为警告消息

  • #10057: 如果项目放置在根目录,则无法扫描文档

  • #9636: 代码块::dedent: 无参数时会去掉换行符