Sphinx 7.1¶
版本 7.1.2 (发布于 2023年8月2日)¶
修复的漏洞¶
#11542: linkcheck: 正确遵守
linkcheck_anchors
的设置,并且不错误地报告验证锚点的失败.补丁由 James Addison 提供.
发布 7.1.1(2023年7月27日发布)¶
修复的漏洞¶
#11514: 修复多行版权页脚中的
SOURCE_DATE_EPOCH
.补丁由 Bénédikt Tran 提供.
发布 7.1.0(发布于 2023 年 7 月 24 日)¶
不兼容的变更¶
发行版不再签名,这是由于 PyPI政策的变化 .
过时¶
#11412: 在:rst:dir:index 指令中使用已弃用的特定Python索引条目类型(即
module
、keyword
、operator
、object
、exception
、statement
和builtin
)时发出警告,并将移除版本设置为Sphinx 9.补丁由Adam Turner提供.
添加的功能¶
#11415: 在生成的HTML中,为包含的JavaScript和CSS资源URI添加一个使用CRC32算法的校验和.
require_sphinx()
现在允许将版本要求指定为(major, minor)
.#11011: 允许通过
maximum_signature_line_length
及其特定领域的变体配置对象签名的行长度限制.如果签名的长度(以字符计)超过配置的限制,则签名中的每个参数将被拆分到其自己的逻辑行中.此行为也可以通过对象描述指令上的选项进行控制,例如py:function:single-line-parameter-list
.补丁由 Thomas Louf、Adam Turner 和 Jean-François B. 提供.#10983: 支持在页脚块中使用多行版权声明.补丁由 Stefanie Molin 提供
sphinx.util.display.status_iterator
now clears the current line with ANSI control codes, rather than overprinting with space characters.#11431: linkcheck: 将SSL故障视为断开链接.补丁由James Addison提供.
#11157: 保持翻译节点上的
translated
属性.#11451: 改善在并行构建中使用
sphinx-build -T
时显示的回溯.补丁由 Bénédikt Tran 提供#11324: linkcheck: 使用基于会话的HTTP请求.
#11438:为PEP 695(通用类和函数声明)和PEP 696(默认类型参数)添加对:rst:dir:py:class 和
py:function
指令的支持.多行支持(#11011)已为类型参数列表启用,并且可以在对象描述指令中局部控制,例如:rst:dir:py:function:single-line-type-parameter-list .补丁由Bénédikt Tran提供.#11484: linkcheck: 允许通过
linkcheck_anchors_ignore_for_url
在每个 URL 的基础上忽略 HTML 锚点,同时仍然检查页面本身的有效性.补丁由 Bénédikt Tran 提供#1246: 通过新的替换(
|translation progress|
)和新的配置变量 (translation_progress_classes
),添加翻译进度统计和检查支持.这些可以用于确定文档中已翻译元素的百分比,以及剩余的已翻译和未翻译元素.
修复的漏洞¶
恢复了在最新(未发布)版本的Docutils中被移除的
footnote-reference
类.#11486: 在EPUB构建器中使用 RFC 8081 字体文件 MIME 类型.使用正确的MIME类型将防止
epubcheck
发出警告,并生成有效的EPUB.#11435: 在
BuildEnvironment.get_outdated_files
中使用微秒级时间戳来检测过期文件.#11437: 顶级标题以reStructuredText角色开头时,现在在设置了
rst_prolog
的情况下能够正确渲染.之前,文件如果以以下内容开头,将因序言文本插入位置不当而渲染不正确.:mod:`lobster` -- The lobster module ==================================== ...
补丁由Bénédikt Tran提供.
#11337:修复在使用
None
或typing.*
作为内联类型引用时,sphinx.ext.intersphinx
中出现的MemoryError
.补丁由 Bénédikt Tran (picnixz) 提供.
测试¶
#11345:在运行
SphinxTestApp.cleanup()
时,始终删除测试目录中的docutils.conf
.