Sphinx6.2

版本6.2.1（2023年4月25日发布）

错误已修复

版本6.2.0（2023年4月23日发布）

依赖关系

  • 需要Docutils 0.18.1或更高版本。

不兼容的更改

  • LaTeX: removal of some internal TeX \dimen registers (not previously publicly documented) as per 5.1.0 code comments in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize, and \sphinxshadowrule. (refs: #11105)

  • 去除 .egg 支持Pycode ModuleAnalyser ; Python eggs是一种现已过时的二进制分发格式

  • #11089：删除中不推荐的代码 sphinx.builders.linkcheck .丹尼尔·艾德斯（Daniel Eades）的补丁

  • 仅删除内部 sphinx.locale.setlocale

弃用

  • #11247：亵渎遗产 intersphinx_mapping 格式

  • sphinx.util.osutil.cd 被反对支持 contextlib.chdir .

功能添加

  • #11277： autoproperty 允许将返回类型指定为类型注释（例如， # type: () -> int ). Bénédikt Tran的补丁

  • #10811：自动摘要：扩展 __all__ 当选项时，导入用于模板渲染的导入成员 autosummary_ignore_module_all 设置为 False .克莱门特·皮纳德（Clement Pinard）的补丁

  • #11147：添加 content_offset 参数以 nested_parse_with_titles() ，允许在嵌套解析期间使用正确的行号。杰里米·麦廷-谢泼德的补丁

  • 更新到Unicode CLDR 42

  • 添加 --jobs 同义词 -j . Hugo van Kemenade的补丁

  • LaTeX：命令 \sphinxbox 对于使用（可能是圆角）框设计文本元素，添加了可选的背景色和阴影。看到 的 \sphinxbox 命令 . (refs：#11224）

  • LaTeX：添加 \sphinxstylenotetitle , ..., \sphinxstylewarningtitle , ...,释放额外的加价层 \sphinxstrong 用于其他用途。看到 宏指令 . (refs：#11267）

  • LaTeX： note , hint , important 和 tip 现在每个都可以被设计为其他警告，即可能具有背景颜色、单独的边界宽度和填充、可能具有圆角和可选阴影。 看到 其他类似于css的内容 'sphinxsetup' 钥匙 . (refs：#11234）

  • LaTeX：警告和 topic （和 contents ）指令，而且不仅 code-block 、支持 box-decoration-break=slice .

  • LaTeX：让圆角框支持多达4种不同的边框宽度（参考文献：#11243）

  • LaTeX：新选择 noteTextColor , noteTeXextras 等人。参见 其他类似于css的内容 'sphinxsetup' 钥匙 .

  • LaTeX：支持圆角框中的椭圆角。(refs：#11254）

  • #11150：当lexing失败时，在突出显示警告中包括源位置。杰里米·麦廷-谢泼德的补丁

  • #11281：支持 imgmath_latex = 'tectonic' 或 = 'xelatex' . Dimitar Dimitrov的补丁

  • #11109、#9643：添加 python_display_short_literal_types 压缩渲染选项 Literal 类型

错误已修复

  • #11079：LaTeX：具有对齐属性的图形可能会消失并奇怪地影响以下列表

  • #11093：LaTeX：修复当一个或多个reST标签直接位于 py:module 或 automodule 指令。补丁作者：Bénédikt Tran（picnixz）

  • #11110：LaTeX：如果数据的文件具有相同的基名并且使用后转换，那么乳胶pdf中的数据就会丢失。 亚伦-库珀的补丁

  • LaTeX：如果设置了阴影颜色但未设置边界颜色，修复从阴影到圆角框边界的潜在颜色泄漏

  • LaTeX：修复代码块框架相对于内容的意外向上1点垂直移动（使用圆角时）

  • #11235：LaTeX：添加 \color 主题（或警告）内容可能会导致断点处阴影和边框的颜色泄露

  • #11264：LaTeX：“Voir aussi”后结肠前缺失空白 seealso 法语指令

  • #11268：LaTeX：左对齐的长表从PDF中的当前列表缩入上下文中中断。 感谢picnixz。

  • #11274：LaTeX：外部链接未正确转义 \sphinxupquote 兼容性

  • #11147：修复对象描述内容和其他用途中的源文件/卡号信息 nested_parse_with_titles . Jeremy Maitin-Shepard的补丁。

  • #11192：恢复正确的并行搜索索引构建。杰里米·麦廷-谢泼德的补丁

  • 使用新的Transifex tx 客户端

测试

  • 发出任何Python警告时测试失败

  • 迁移剩余 unittest.TestCase 将测试函数的样式转换为pytest样式

  • 删除依赖setuptools的测试