Sphinx4.3¶
版本4.3.2(2021年12月19日发布)¶
错误已修复¶
#9917:无论简单类型说明符的顺序如何,C和C++都会解析基本类型。
版本4.3.1(2021年11月28日发布)¶
功能添加¶
#9864:mathjax:支持将MathJax的加载方法更改为“defer”,通过
mathjax_options
错误已修复¶
#9838:autodoc:在构建由functools装饰的函数的文档时会引发Veritas错误。lru_ache
#9879:autodoc:在生成具有无效的对象的文档时引发Veritas错误 __doc__ 属性
#9844:autodoc:无法处理用functools.partial包装的函数,如果
autodoc_preserve_defaults
启用#9872:html:autodoc签名和Docutils 0.17之间的类命名空间冲突
#9868:imgmath:如果dvisvGM命令未能转换方程,则崩溃
#9864:mathspel:无法通过MathJax v2渲染方程。 MathJax的加载方法再次回到“Deliverc”方法
版本4.3.0(2021年11月11日发布)¶
依赖关系¶
支持Python 3.10
不兼容的更改¶
九千六百四十九号:
searchindex.js
:嵌入的数据已更改格式,以允许具有相同名称的对象在不同的域中。#9672:Python域声明的呈现是通过更多Docutils节点实现的,以实现更好的CSS样式。它可能会打破现有的造型。
#9672:签名
domains.python.PyObject.get_signature_prefix
已更改为返回节点列表而不是普通字符串。#9695:
domains.js.JSObject.display_prefix
已经变成了一种方法get_display_prefix
它现在返回节点列表,而不是纯字符串。#9695:使用更多Docutils节点实现了JavaScript域声明的渲染,以实现更好的CSS样式。它可能会打破现有的造型。
#9450:mathspel:通过“延迟”策略加载MathJax
弃用¶
sphinx.ext.autodoc.AttributeDocumenter._datadescriptor
sphinx.writers.html.HTMLTranslator._fieldlist_row_index
sphinx.writers.html.HTMLTranslator._table_row_index
sphinx.writers.html5.HTML5Translator._fieldlist_row_index
sphinx.writers.html5.HTML5Translator._table_row_index
功能添加¶
#9639:autodoc:支持同步生成器函数
#9664:autodoc:
autodoc-process-bases
支持将reST代码段作为基类注入#9691:C,添加了新的信息字段
retval
为c:function
和c:macro
.C++,添加了新的信息字段
retval
为cpp:function
.#9618:i18 n:添加
gettext_allow_fuzzy_translations
允许“模糊”消息进行翻译#9672:有关Python域描述的更多CSS类
#9695:有关JavaScript域描述的更多CSS类
#9683:恢复删除
add_stylesheet()
API. 它将一直保留到Sphinx 6.0发布#2068,添加
intersphinx_disabled_reftypes
用于禁用没有明确库存规范的交叉引用的interphinx解析。可以禁用特定类型的交叉引用,例如std:doc
或特定领域中的所有交叉引用,例如,std:*
.#9623:允许使用抑制“toctree包含对排除文档的引用”警告
suppress_warnings
错误已修复¶
#9630:autodoc:如果出现以下情况,则无法构建交叉引用
primary_domain
不是“py”#9644:autodoc:从有问题的对象获取源信息时崩溃
#9655:autodoc:具有文档注释的被模拟对象意外警告
#9651:autodoc:返回类型字段不生成,即使
autodoc_typehints_description_target
当其信息字段列表包含时,则设置为“documented”:returns:
领域#9657:autodoc:被模仿对象的子集的Base不正确
#9607:autodoc:对通用类的子集进行不正确的Base Class检测
#9755:autodoc:显示别名的内存地址
#9752:autodoc:未能检测插槽属性的类型注释
#9756:autodoc:如果classmethod没有 __func__ 属性
#9757:autodoc:
autodoc_inherit_docstrings
不影响重写的类方法#9781:autodoc:
autodoc_preserve_defaults
不支持十六进制数字#9630:自动摘要:如果出现以下情况,则无法构建摘要表
primary_domain
不是“py”#9670:html:修复带有特殊字符的下载文件
#9710:html:嵌套表中偶数/奇数行的样式错误
#9763:html:参数名称及其类型注释在HTML中没有分开
#9649:HTML搜索:当对象具有相同的名称但位于不同的域时,将所有对象作为结果返回,而不是仅返回一个。
#7634:interphinx:子目录中文件的引用已损坏
#9737:LaTeX:hlist呈现为包含“aggedrigight”文本的列表
#9678:linkcheck:文件扩展名在警告中显示两次
#9697:py域:已注册带有括号的索引条目
py:method
指令:property:
选项#9775:py域:当出现时,文字类型提示被转换为交叉引用
autodoc_typehints
='description'
#9708:needs_extension未能正确检查两位数版本
#9688:修复Sphinx补丁 code 不承认
:class:
选项#9733:修复文档构建过程中记录处理程序刷新警告
#9656:修复警告,而不会错误抑制子类型
Interphinx,用于具有明确清单的未解决引用,例如,
proj:myFunc
,在未解析的文本中保留库存前置。