变更日志¶
发布 8.1.0(开发中)¶
依赖项¶
#12756: 为
sphinxcontrib-*
依赖项添加下限.补丁由 Adam Turner 提供.
不兼容的更改¶
#12763: 移除未使用的内部类
sphinx.util.Tee
.补丁由 Adam Turner 提供.
自 已弃用 版本弃用.¶
#12762: 弃用
sphinx.util.import_object
.请改用importlib.import_module()
.补丁由 Adam Turner 提供.#12766: 废弃
sphinx.util.FilenameUniqDict
和sphinx.util.DownloadFiles
.补丁由 Adam Turner 提供.
添加的功能¶
#11328: 在生成静态输出文件的过程中提及模板内容的评估.
#12704: LaTeX: 使 contents 、topic 和 sidebar 指令在PDF输出时可单独自定义.补丁由 Jean-François B. 和 Bénédikt Tran 提供.
#12474: 通过CSS支持基于类型的搜索结果高亮显示.补丁由Tim Hoffmann提供.
#12652: LaTeX: 为 LaTeX 构建器添加
math_numsep
支持.补丁由 Thomas Fanning 和 Jean-François B. 提供.#12743: 使用
--fail-on-warning
时,不再在第一个警告时退出.相反,如果在构建过程中生成了任何警告,则以非零状态退出.补丁由 Adam Turner 提供.#12743: 添加
sphinx-build --exception-on-warning
,在构建过程中发出警告时引发异常.补丁由 Adam Turner 和 Jeremy Maitin-Shepard 提供.
修复的错误¶
#12514: intersphinx: 修复
intersphinx_cache_limit
的负值含义.修补由张盛宇提供.#12722: LaTeX: 避免TeX报告
Overfull \hbox
,因为问题实际上已通过:ref:latexsphinxsetupforcewraps 解决.补丁由Jean-François B.提供.#12730:
UnreferencedFootnotesDetector
转换功能已改进,以更一致地检测未引用的脚注.请注意,该转换的优先级已从 200 更改为 622,因此它现在在 docutils 的Footnotes
解析转换之后运行.补丁由 Chris Sewell 提供.#12778: LaTeX: 让 :ref:`’sphinxsetup’ <latexsphinxsetup>```div.topic_box-shadow``键在仅设置一个维度时,根据文档同时设置 x-offset 和 y-offset.
#12587: 当因大小写不敏感的重复目标导致 Intersphinx 解析时检测到潜在歧义时,不再发出警告.补丁由 James Addison 提供.
#12639: 修复单数和复数搜索结果文本.补丁由Hugo van Kemenade提供.
#12645:正确支持自定义 gettext 输出模板.补丁由 Jeremy Bowman 提供.
#12717: LaTeX: 让
-q
(安静) 选项适用于 sphinx-build -M latexpdf 或 make latexpdf (O=-q
) 并传递给 latexmk .让-Q
(静默) 也适用于 PDF 构建阶段. 补丁由 Jean-François B. 提供.#12744: LaTeX: 通过自定义解释文本角色注入的类现在会产生嵌套的
\DUrole
,而不是一个用逗号分隔的类.补丁由让-弗朗索瓦·B 提供.#11970, #12551: singlehtml构建器:使目标URI成为符合 RFC 3986, §4.4 的同文档引用,例如,
index.html#foo
变为#foo
. (注意:这是在 Sphinx 7.3.0 中添加的部分修复的延续) 补丁由 James Addison 提供(参考 Eric Norige 之前的工作)#12782: intersphinx: 修复生成库存文件URL时出现双斜杠的问题(即使用户定义的intersphinx项目的基URL以双斜杠结尾,也不会被更改).补丁由Bénédikt Tran提供.
测试¶
#12141: 从已弃用的
karma
JavaScript 测试框架迁移到积极维护的jasmine
框架.测试覆盖率未受影响.补丁由 James Addison 提供.
先前版本¶
- Sphinx 8.0
- Sphinx 7.4
- Sphinx 7.3
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Sphinx 1.3
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1