Sphinx 3.3

发布版本 3.3.1（发布于 2020 年 11 月 12 日）

修复的错误

  • #8372: autodoc: autoclass 指令比 Sphinx 3.2 慢

  • #7727: autosummary: 在没有 __init__.py 的情况下记录 python 包时引发 PycodeError

  • #8350:autosummary:autosummary_mock_imports导致构建变慢

  • #8364: C,正确初始化空符号中的属性.

  • #8399: 国际化: 将系统区域设置路径放在配置指定的路径之后

发布版本 3.3.0（于 2020 年 11 月 02 日发布）

过时

  • sphinx.builders.latex.LaTeXBuilder.usepackages

  • sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref

  • sphinx.ext.autodoc.SingledispatchFunctionDocumenter

  • sphinx.ext.autodoc.SingledispatchMethodDocumenter

添加的功能

  • #8100: html: 在复制 html_static_files 失败时显示更好的错误信息

  • #8141: C: 为 c:alias 添加了 maxdepth 选项,以插入嵌套声明.

  • #8081: LaTeX: 允许通过 app.add_latex_package() 添加 LaTeX 包,直到写入 .tex 文件之前

  • #7996: 手册页: 添加 man_make_section_directory 以在构建手册页时创建一个章节目录

  • #8289: epub: 允许通过 suppress_warnings 抑制 epub 构建器中的 “发现重复的 ToC 条目” 警告.

  • #8298: sphinx-quickstart: 添加 sphinx-quickstart --no-sep 选项

  • #8304: sphinx.testing: 在sphinx.testing.fixtures中注册公共标记

  • #8051: napoleon: 对所有 “另见” 项目使用 obj 角色

  • #8050: napoleon: 将 napoleon_preprocess_types 应用到每个字段

  • C 和 C++,在检测到重复声明时显示之前声明的行号.

  • #8183: 仅在LaTeX构建中从文档树中移除substitution_reference节点

修复的错误

  • #8085: i18n: 增加对单一文本域的支持

  • #6640: 本地化:无法覆盖系统消息翻译

  • #8143: autodoc: 当传递 False 值给 autodoc_default_options 时,抛出 AttributeError

  • #8103: autodoc: functools.cached_property 不被视为属性

  • #8190:autodoc:如果某个扩展用不以空行结尾的字符串替换文档字符串,则会引发解析错误

  • #8142: autodoc:从 typing.Generic 派生的类的构造函数签名错误

  • #8157: autodoc: 当注解具有无效的 __args__ 时引发 TypeError

  • #7964: autodoc: 默认值中的元组错误渲染

  • #8200:autodoc:类型别名破坏自动属性的类型格式

  • #7786: autodoc: 无法检测在其他文件中定义的重载方法

  • #8294: autodoc: 单字符串 __slots__ 处理不正确

  • #7785: autodoc: autodoc_typehints=’none’ 对重载函数没有影响

  • #8192: napoleon: 当描述包含行内文字时消失

  • #8142: napoleon: 在谷歌风格文档中潜在的正则表达式拒绝服务攻击

  • #8169: LaTeX: 即使latex_engine并非platex,pxjahyper依然被加载

  • #8215: LaTeX: ‘oneside’ 类选项导致构建警告

  • #8175: intersphinx: 通过损坏的清单可能导致的正则表达式拒绝服务攻击

  • #8277: sphinx-build: 构建时控制台输出缺少和多余的空格（等）

  • #7973: imgconverter: 多次检查imagemagick的可用性

  • #8255: py 域: 默认参数值中的数字由十六进制更改为十进制

  • #8316: html: 防止在按钮元素获得焦点时,箭头键改变页面

  • #8343: html 搜索:修复解析文档时不必要加载图像的问题

  • #8254: html 主题: 行号与代码行不对齐

  • #8093: 在某些构建器（LaTeX、singlehtml等）中,高亮警告位置错误

  • #8215: 消除单面文档的 Fancyhdr 构建警告

  • #8239: 如果生产列表中的令牌有缩进,引用失败

  • #8268: linkcheck: 当 linkcheck_anchors 为 True 时报告 HTTP 错误

  • #8245: linkcheck: 考虑本地文件的源目录

  • #8321: linkcheck: 检测到 tel: 方案的超链接为错误

  • #8323: linkcheck: 当发现具有不支持的模式的链接时,退出状态不正确

  • #8188: C,向内部对象类型字典添加缺失项,例如,防止intersphinx解析它们.

  • C,修复intersphinx中的匿名对象.

  • #8270, C++,如果已存在同名的非函数声明,则正确拒绝函数作为重复声明.

  • C,修复对函数参数的引用.链接到函数而不是不存在的锚点.

  • #6914: 未标注项意外地分配了图号

  • #8320: 使”inline”行号不可选择

测试

  • #8257: 支持在 sphinx.testing 中进行并行构建