Sphinx 2.4¶

Release 2.4.5 （发布于2021年11月18日）¶

依赖关系¶

#9807:将Docutils限制为0.17.x或更早版本

发布版本 2.4.4（发布于 2020 年 3 月 5 日）¶

修复的 bug¶

#7197: LaTeX: platex 引起构建具有目标 URL 的图像指令的错误
#7223: 自2.4.0版本以来,Sphinx的构建速度变慢

版本 2.4.3（发布于 2020 年 2 月 22 日）¶

修复的 bug¶

#7184: autodoc:*args 和 **kwarg 在类型注释中未被正确处理
#7189:autodoc:类方法协程未被检测
#7183: intersphinx::attr: 对属性的引用已损坏
#6244, #6387: html搜索:使用dirhtml构建时搜索中断/挂起
#7195:待办事项:在非文档节点不正确时发出 doctree-resolved 事件

发布 2.4.2（发布于 2020 年 2 月 19 日）¶

修复的 bug¶

#7138: autodoc:autodoc.typehints 在变量的值为未绑定对象时崩溃
#7156: autodoc: 仅关键字参数的分隔符未显示
#7146: autodoc: 抑制的 type_comment 发现时引发 IndexError
#7161: autodoc: typehints 扩展不支持并行构建
#7178: autodoc: 在获取类型注解时引发 TypeError
#7151: 扩展给 env.indexentries 赋值时崩溃
#7170: text: 删除调试打印
#7137: viewcode: 避免在给定非Python代码时崩溃

Release 2.4.1（发布于2020年2月11日）¶

修复的 bug¶

#7120: html: 在缩放具有浮动尺寸的SVG图像时崩溃
#7126: autodoc: TypeError: ‘getset_descriptor’ 对象不可迭代

Release 2.4.0 (发布于 2020年2月9日)¶

被弃用¶

The decode argument of sphinx.pycode.ModuleAnalyzer()
sphinx.directives.other.Index
sphinx.environment.temp_data['gloss_entries']
sphinx.environment.BuildEnvironment.indexentries
sphinx.environment.collectors.indexentries.IndexEntriesCollector
sphinx.ext.apidoc.INITPY
sphinx.ext.apidoc.shall_skip()
sphinx.io.FiletypeNotFoundError
sphinx.io.get_filetype()
sphinx.pycode.ModuleAnalyzer.encoding
sphinx.roles.Index
sphinx.util.detect_encoding()
sphinx.util.get_module_source()
sphinx.util.inspect.Signature
sphinx.util.inspect.safe_getmembers()
sphinx.writers.latex.LaTeXTranslator.settings.author
sphinx.writers.latex.LaTeXTranslator.settings.contentsname
sphinx.writers.latex.LaTeXTranslator.settings.docclass
sphinx.writers.latex.LaTeXTranslator.settings.docname
sphinx.writers.latex.LaTeXTranslator.settings.title
sphinx.writers.latex.ADDITIONAL_SETTINGS
sphinx.writers.latex.DEFAULT_SETTINGS
sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG
sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG

特性添加¶

#6910: inheritance_diagram: 使图表的背景透明
#6446: 持续时间: 添加 sphinx.ext.durations 以检查哪些文档减慢构建速度
#6837: LaTeX: 支持嵌套表格
#7115: LaTeX: 允许通过环境变量覆盖 LATEXOPTS 和 LATEXMKOPTS
#6966: graphviz: 支持 :class: 选项
#6696: html::scale: 选项在 SVG图像（需要 imagesize-1.2.0 或更高版本）的 image/figure 指令中不起作用
#6994:imgconverter:支持将illustrator文件（.ai）转换为.png
autodoc: 支持仅位置参数分隔符（符合PEP-570）
autodoc: 支持变量的类型注解
#2755: autodoc: 添加新事件:autodoc-before-process-signature
#2755: autodoc: 支持 type_comment 风格 (例如 # type: (str) -> str ) 注释（需要 Python 3.8+ 或 typed_ast ）
#7051: autodoc: 支持没有默认值的实例变量 (PEP-526)
#6418: autodoc: 添加一个新扩展 sphinx.ext.autodoc.typehints .如果设置 autodoc_typehints = "description" ,它将类型提示显示为对象描述.这是一个实验性扩展,并将在 Sphinx 3.0 中集成到 autodoc 核心中
SphinxTranslator 现在会在未找到原始节点类的访问者/离开方法时,调用超节点类的访问者/离开方法
#6418: 添加新事件: object-description-transform
py 域: py:data 和 py:attribute 增加了新的选项 :type: 和 :value: 用于描述其类型和初始值
#6785: py 域::py:attr: 能够再次引用属性
#6772: apidoc: 添加 -q 选项以启用静默模式

修复的 bug¶

#6925: html: 从 <script> 元素中移除多余的 type=”text/javascript”
#7112: html: SVG 图像未按浮动布局,即使已对齐
#6906, #6907: autodoc: 无法读取编码为cp1251的源代码
#6961: latex: babel 警告显示两次
#7059: latex: LaTeX 编译陷入无限循环（wrapfig 问题）
#6581: latex::reversed: 选项对 toctree 在 LaTeX 构建中没有影响
#6559: 在词汇指令中生成了错误的节点ID
#6986: apidoc: 错误检测模块名,对于模块内部的 .so 文件
#6899: apidoc: 即使给定了 --private ,私有成员仍未显示
#6327: apidoc: 支持由 __init__.so 文件组成的 python 包
#6999: napoleon: 无法解析 :exc: 角色中的波浪号
#7019: gettext: 消息目录中使用绝对路径
#7023: autodoc: 嵌套的部分函数不被列出
#7023: autodoc: 从其他模块导入的部分函数被列为模块成员,而没有 :imported-members: 选项
#6889 : autodoc::members:: 选项中的尾随逗号导致模糊警告
#6568: autosummary:autosummary_imported_members 在为子模块生成存根文件时被忽略
#7055:linkcheck:重定向被视为错误
#7088: HTML 模板:如果激活了 navigation_with_keys 选项,则修改键会被忽略,这意味着该功能可能会干扰浏览器功能
#7090: 标准域:无法为自定义容器节点分配 numfig-编号
#7106: 标准域:当扩展调用 note_explicit_target() 时,枚举节点被标记为重复
#7095:dirhtml:通过 intersphinx 和 :doc: 角色的交叉引用已损坏
C++:
- 在某些情况下使用 struct 角色时不崩溃.
- 在使用 var / member 角色处理函数参数时不要发出警告.
- 正确渲染调用和花括号初始化表达式.
#7097: 由 sphinx.transforms.post_transforms.images.ImageConverter 或其子类生成的图像文件名（用于latex构建）现在已被清理,以防止路径破损