Sphinx 2.4

Release 2.4.5 (released Nov 18, 2021)

依赖

  • #9807: Restrict Docutils to 0.17.x or older

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

Bug 修复

  • #7197：LaTeX:platex 导致生成目标 url 的图像指令出错

  • #7223：Sphinx 构建自调试模式下的 2.4.0 以来较为缓慢

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

Bug 修复

  • #7184：autodoc：类型注释中的 *args 和 **kwarg 处理不当

  • #7189：autodoc：未检测到类方法协同例程

  • #7183：interspinx: :attr: 对属性的引用已断开

  • #6244, #6387: html 搜索：使用 dirhtml builder 生成时搜索中断/挂起

  • #7195：todo：发出 doctree 解析的非文档节点事件不正确

2.4.2版（2020年2月19日发布）

Bug 修复

  • #7138: autodoc: 当对象的值未绑定时 autodoc.typehints 崩溃

  • #7156: autodoc: 不显示仅含关键字参数的分隔符

  • #7146：autodoc：在找到抑制类型的注释时引发索引器错误

  • #7161：autodoc：typehints扩展不支持并行生成

  • #7178：autodoc：获取类型批注时引发 TypeError

  • #7178：autodoc：获取类型批注时引发 TypeError

  • #7170：text：移除排错打印

  • #7137：viewcode：避免了无 Python 代码时的崩溃

版本2.4.1（于2020年2月11日发布）

Bug 修复

  • #7120：html：在缩放具有浮动维度的 SVG 图像时崩溃

  • #7126: autodoc: TypeError: 'getset_descriptor' 对象不可迭代

2.4.0版（2020年2月9日发布）

已弃用

  • 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：duration：添加 'sphinx.ext.durations' 以检查哪些文档拖慢了构建速度

  • #6837：LaTeX：支持嵌入式表格

  • #7115：LaTeX：允许通过环境变量覆盖 LATEXOPTS 和LATEXMKOPTS

  • #6966：graphviz：支持 :class: 选项

  • #6696：html：图/表的 :scale: 指令选项在 SVG（需要imagesize-1.2.0或更高版本）中失效

  • #6994：imgconverter：支持 illustrator （.ai）文件到 .png 的转换

  • autodoc：支持仅位置参数分隔符（符合PEP-570）

  • autodoc：支持变量的类型注释

  • #2755：autodoc：增加了一个新的事项 autodoc-before-process-signature

  • #2755：autodoc：支持 type_comment 样式 (ex. # type: (str) -> str) 注释 （需要 python3.8+ 或 typed_ast ）

  • #7051：autodoc：支持示例变量无默认值（PEP-526）

  • #6418: autodoc: Add a new extension sphinx.ext.autodoc.typehints. It shows typehints as object description if autodoc_typehints = "description" set. This is an experimental extension and it will be integrated into autodoc core in Sphinx 3.0

  • 如果找不到原始节点类的访问/离开方法，SphinxTranslator 将为超级节点类调用访问/离开方法

  • #6418：增加新的事项：object-description-transform

  • py 域：py:data 和 py:attribute 启用新选项名称 :type: 和 :value: 来描述其类型和初始值

  • #6785：py 域： :py:attr: 能够再次引用属性

  • #6772：apidoc： 静音模式增加 -q 选项

Bug 修复

  • #6925：html：移除冗余类 ="text/javascript" 从 <script> 元素

  • #7112：html：对齐吼 SVG 图像无法显示为浮动样式

  • #6906, #6907: autodoc: failed to read the source codes encoded in cp1251

  • ＃6961：latex：babel 警告显示两次

  • #7059：latex：LaTeX 编译陷入无限循环（wrapfig问题）

  • #6581：latex：toctree 的 :reversed: 选项f在构建中无效

  • ＃6559：词汇表指令中生成了错误的节点 ID

  • ＃6986：apidoc：在模块内部错误检测到 .so 文件的模块名称

  • ＃6899：apidoc：在给定 --private 时也不会显示私有成员

  • #6327：apidoc：支持由 __init__.so 文件组成的 python 包

  • #6999：napoleon：未能在：exc：角色中解析波浪号

  • ＃7019：gettext：消息目录中使用的绝对路径

  • ＃7023：autodoc：部分嵌套函数未列出

  • ＃7023：autodoc：从其他模块导入的部分函数列为不带：impoprted-members：选项的模块成员

  • ＃6889：autodoc：在 ：members :: 选项中尾部逗号引起隐式警告

  • ＃6568：autosummary：在为子模块生成存根文件时会忽略 autosummary_imported_members

  • ＃7055：linkcheck：重定向被视为错误

  • ＃7088：HTML模板：如果激活了 “ navigation_with_keys” 选项，则会忽略修饰键，这意味着该功能可能会干扰浏览器功能

  • ＃7090：std域：无法为自定义容器节点分配 numfig-numbers

  • ＃7106：std域：当扩展调用 note_explicit_target() 时，枚举节点被标记为重复

  • ＃7095：dirhtml：交叉引用通过 intersphinx 和 :doc: 角色被破坏

  • C++：

    • 在某些情况下使用 struct 角色时不要崩溃。

    • 在函数参数中使用 var/member 角色时不发出警告。

    • 正确渲染调用和支撑初始表达式。

  • ＃7097：“ sphinx.transforms.post_transforms.images.ImageConverter” 或其子类（用于 Latex 构建）生成的图像的文件名现已清理，以防止路径中断