Sphinx 5.1¶
发布 5.1.1(发布于 2022 年 7 月 26 日)¶
修复的BUG¶
#10701: 修复新
deque
基于sphinx.ext.napoleon
的迭代器实现中的 ValueError.#10702: 恢复与第三方构建工具的兼容性.
发布 5.1.0(发布于 2022 年 7 月 24 日)¶
依赖项¶
#10656: 支持 Docutils 0.19 .补丁由 Adam Turner 提供.
过时¶
#10467: 不推荐使用
sphinx.util.stemmer
,建议使用snowballstemmer
.补丁由 Adam Turner 提供.#9856: 废弃
sphinx.ext.napoleon.iterators
.
功能添加¶
#10444: html主题:允许通过在
theme.conf
中设置stylesheet
,或将html_style
设置为字符串可迭代对象来指定多个CSS文件.#10366: 标准领域:通过新的
option_emphasise_placeholders
配置选项,增加对option
指令中强调占位符的支持.#10439: std 域:在显示警告时使用某些变量的 repr,从而使空格问题更易于识别.
#10571: 快速入门:减少生成的
conf.py
文件中的内容.补丁由 Pradyun Gedam 提供.#10648: LaTeX: CSS类似的额外 ‘sphinxsetup’ 键允许配置四个独立的边框宽度、四个填充、四个角半径、一个阴影(可能是内阴影),以及每个代码块、主题、注意、警告、危险、错误和警示指令的边框、背景、阴影的颜色.
#10655: LaTeX: 解释 LatinRules.xdy 中的非标准编码
#10599: HTML主题:在使用Docutils 0.18或更高版本时,将连续的脚注包装在
<aside>
元素中,以便于样式调整.这与Docutils 0.19中引入的行为相匹配.补丁由亚当·特纳提供.#10518: 配置: 增加
include_patterns
作为exclude_patterns
的相反项.补丁由 Adam Turner 提供.
修复的BUG¶
#10594: HTML主题:如果使用Docutils 0.18+,字段术语的冒号会重复出现
#10596:如果 Docutils 版本为 0.18(而不是 0.18.1),由于缺少
Node.findall()
,导致构建失败#10506: LaTeX: 如果在图形标题中突出显示内联代码角色,则构建错误 (参考: #10251)
#10634: 使 -P (pdb) 选项更好地处理由事件触发的异常
#10550: py domain: 修复在反解析各种运算符(
+
,-
,~
, 和**
)时出现的多余空白.补丁由 Adam Turner 提供(参考:#10551).#10460: 日志记录: 始终将节点源位置显示为绝对路径.
HTML搜索:HTML标签作为对象名称的一部分显示
HTML 搜索:搜索片段不应折叠
HTML搜索:在获取搜索片段时会发出一些小错误
HTML搜索:标题链接的标记将在搜索结果中显示
#10520: HTML主题:修复
agogo.css_t
中侧边栏类的使用.#6679: HTML主题:修复agogo主题中隐藏toctrees的包含问题.
#10566: HTML主题: 修复enable_search_shortcuts不起作用
#8686: LaTeX: 文字可能在页面末尾从代码块中溢出,并在下页留下伪影
#10633: LaTeX: 用户注入的
\color
命令在主题或警告框中可能由于上游 framed.sty 的bug导致PDF中的颜色泄漏#10638: LaTeX:在高亮代码中(例如,使用 Pygments 风格
'manni'
的高亮差异)的带边框彩色框继承代码块边框的厚度#10647: LaTeX:即使
desc_signature
节点有多个节点ID,仍然只生成一个\label
#10579: i18n: 在翻译原始指令时引发UnboundLocalError
#9577, #10088: py 域:修复使用
:any:
和 autodoc 时重复 Python 引用的警告.#10548: HTML搜索: 修复小的摘要问题.