Sphinx 5.2

版本 5.2.3（2022 年 9 月 30 日发布）

  • #10878：修复 sphinx.ext.imgmath 中的 base64 图像嵌入

  • #10886：添加 :nocontentsentry: 标志和全局域目录条目控制选项。补丁由 Adam Turner 提供

版本 5.2.2（2022 年 9 月 27 日发布）

  • #10872：将 autodoc 模块的链接目标恢复到内容的顶部。补丁由 Dominic Davis-Foster 提供。

版本 5.2.1（2022 年 9 月 25 日发布）

修复的 Bug

  • #10861：始终将 pycon3 词法分析器规范化为 pycon。

  • 修复在模块级文档字符串中包含标题的模块中使用 sphinx.ext.autosummary 的问题。

版本 5.2.0.post0（2022 年 9 月 24 日发布）

  • 为 Debian 维护者重新创建了源 tarball。

版本 5.2.0（2022 年 9 月 24 日发布）

依赖项

  • #10356：Sphinx 现在使用带有 pyproject.toml 的声明式元数据来创建包，使用 PyPA 的 flit 项目作为构建后端。补丁由 Adam Turner 提供。

已弃用

  • #10843：支持 HTML 4 输出。补丁由 Adam Turner 提供。

新增功能

  • #10738：napoleon：添加对使用“of”的文档字符串类型的支持，例如 type of type。示例：tuple of int。

  • #10286：C++，支持不只是在模板参数列表和声明之间需要子句。

  • #10755：linkcheck：检查使用 url 选项的原始指令的源 URL。

  • #10781：允许 ref 角色与定义和字段一起使用。

  • #10717：HTML 搜索：提高搜索结果中完整标题和副标题匹配的优先级

  • #10718：HTML 搜索：将搜索结果分数保存到 HTML 元素中以进行调试

  • #10673：使 toctree 接受 'genindex'、'modindex' 和 'search' 文档名称

  • #6316，#10804：将域对象添加到目录。补丁由 Adam Turner 提供

  • #6692：HTML 搜索：将显式 index 指令索引条目包含在搜索索引和搜索结果中。补丁由 Adam Turner 提供

  • #10816：imgmath：允许将图像以 base64 格式嵌入 HTML

  • #10854：HTML 搜索：使用浏览器本地存储进行高亮控制，停止在 URL 查询字符串中存储高亮参数。补丁由 Adam Turner 提供。

修复的 Bug

  • #10723：LaTeX：5.1.0 已使 'sphinxsetup' verbatimwithframe=false 变得无效。

  • #10257：C++，确保一致的非特化模板参数表示。

  • #10729：C++，修复某些非类型模板参数包的解析。

  • #10715：恢复 #10520：“修复”agogo.css_t 中侧边栏类的使用