Sphinx7.2¶
版本7.2.6(2023年9月13日发布)¶
错误已修复¶
#11679;加
SPHINX_AUTODOC_RELOAD_MODULES
环境变量,如果设置了该变量,则在使用autodoc时重新加载模块TYPE_CHECKING = True
.马特·沃兹尼斯基(Matt Wozniski)和亚当·特纳(Adam Turner)的补丁。#11679:使用
importlib.reload()
在autodoc中重新加载模块。马特·沃兹尼斯基(Matt Wozniski)和亚当·特纳(Adam Turner)的补丁。
版本7.2.5(2023年8月30日发布)¶
错误已修复¶
#11645:修复阻止autodoc导入使用的包中的模块的回归
if typing.TYPE_CHECKING:
以保护类型检查员所需的循环导入。马特·沃兹尼斯基(Matt Wozniski)的补丁。#11634:修复了收件箱中兄弟文件的继承关系图相对链接解析。作者:Albert Shih。
#11659:允许
?config=...
在mathjax_path
.#11654:autodoc:当对象声称是的实例时,失败并显示更具描述性的错误消息
type
,但不是一个类。詹姆斯·布拉扎(James Braza)的补丁。11620:停止发射
source-read
通过读取文件的事件 include 指令。11620:添加新
include-read
用于通过观察和转换包含文件的内容 include 指令。#11627:恢复对表单版权行的支持
YYYY
当SOURCE_DATE_EPOCH
已设置。
版本7.2.4(2023年8月28日发布)¶
错误已修复¶
#11618:修复#10478(#9662)中引入的MoveModuleTarget转换中的回归。
#11649:linkcheck:解决伦敦以西时区的挂起测试以及从UTC到UNIXepoch的错误转换。由德米特里·沙赫涅夫和亚当·特纳制作的补丁。
版本7.2.3(2023年8月23日发布)¶
依赖关系¶
#11576:需要sphinxcontrib-serializinghtml 1.1.9。
错误已修复¶
修复回归
autodoc.Documenter.parse_name()
.修复SON序列化中的回归。
#11543:autodoc:支持仅位置参数
classmethod
种方法autodoc_preserve_defaults
是True
.恢复路径对象上的支持字符串方法。这已被弃用,并将在Sphinx 8中删除。使用
os.fspath()
转换Path
对象到字符串,或者Path
的处理路径对象的方法。
版本7.2.2(2023年8月17日发布)¶
错误已修复¶
修复的签名
StateMachine.insert_input()
补丁,用于使用关键字参数进行调用时。固定会员测试 (
in
)对于str
资产类别的接口 (_CascadingStyleSheet
和_JavaScript
),几个扩展都依赖它。修正了一个类型错误,
SingleFileHTMLBuilder._get_local_toctree
,includehidden
可以作为字符串或布尔值传递。修复
:noindex:
为PyModule
和JSModule
.
版本7.2.1(2023年8月17日发布)¶
错误已修复¶
恢复了
str
资产类别的接口 (_CascadingStyleSheet
和_JavaScript
),几个扩展都依赖它。这将在Sphinx9中删除。已恢复通话
Builder.add_{css,js}_file()
,几个扩展都依赖它。恢复了私有API
TocTree.get_toctree_ancestors()
,几个扩展都依赖它。
版本7.2.0(2023年8月17日发布)¶
依赖关系¶
#11511:放弃Python 3.8支持。
#11576:需要Pygments 2.14或更高版本。
弃用¶
#11512:亵渎
sphinx.util.md5
和sphinx.util.sha1
.使用hashlib
而不是.#11526:亵渎
sphinx.testing.path
.使用os.path
或pathlib
而不是.#11528:亵渎
sphinx.util.split_index_msg
和sphinx.util.split_into
.使用sphinx.util.index_entries.split_index_msg
而不是.弃用
sphinx.builders.html.Stylesheet
和sphinx.builders.html.Javascript
.使用sphinx.application.Sphinx.add_css_file()
和sphinx.application.Sphinx.add_js_file()
而不是.#11582:亵渎
sphinx.builders.html.StandaloneHTMLBuilder.css_files
和sphinx.builders.html.StandaloneHTMLBuilder.script_files
.使用sphinx.application.Sphinx.add_css_file()
和sphinx.application.Sphinx.add_js_file()
而不是.第11459章:弃用
sphinx.ext.autodoc.preserve_defaults.get_function_def()
.由Bénédikt Tran修补。
功能添加¶
#11526:支持
os.PathLike
类型和pathlib.Path
更多地方的物品。#5474:coverage:打印汇总统计表。由Jorge Leitao提供补丁。
#6319:viewcode:添加
viewcode_line_numbers
以控制是否将行号添加到渲染的源代码中。Ben Krikler的补丁。#20062;加一个
:no-typesetting:
选项可抑制文本输出并仅创建收件箱锚点。补丁由Latosha Maltba制作。#11221:C++:支持内容列表中的域对象。补丁由Ottlan Korneychuk。
#10938:doctest:添加
doctest_show_successes
选项.补丁由Trey Hunner制作。#11533:添加
:no-index:
,:no-index-entry:
,而且:no-contents-entry:
.#11572:改进
debug
记录文件被检测到过期的原因。埃里克·拉尔森的补丁。#10678:发射
source-read
通过读取文件的事件 include 指令。饰Halldor Fannar#11570:使用时使用缩写名称 PEP 585 内置仿制药。补丁由Riccardo Mori制作。
#11300:改善
SigElementFallbackTransform
回退逻辑和签名文本元素节点。看到 the documentation 了解更多详细信息。由Bénédikt Tran修补。允许运行Sphinx
python -m sphinx build ...
.
错误已修复¶
#11077:graphviz:从图形中修复相对链接。Ralf Grubenmann的补丁。
#11529:LaTeX构建器中的Line Block输出虚假的空令牌。阿德里安·沃尔默(Adrian Vollmer)的补丁。
#11196:自动摘要:摘要行提取失败,并显示“e.g. "
#10614:修复了继承图中导致链接丢失或断开的一些错误。作者:Albert Shih。
#9428:运行时删除替换定义
gettext
建造者。由Alvin Wong修补。#10795:如果出现描述性错误,
graphviz_dot
是假的。#11546:与其原始文本相同的翻译节点现在标记有
translated=True
属性#10049:html:将链接锚中标题文本的“Permalink”更改为“Link”。
#4225:放松对lexing失败的Pygets解析。
#11246:允许文档字符串的第一行中的内联链接和一行类型的注释
#: :meta ...:
当使用sphinx.ext.napoleon
.由Bénédikt Tran修补。#10930:突出显示搜索结果页面上的所有搜索项。德米特里·沙赫涅夫(Dmitry Shachnev)的补丁。
#11473:类型注释包含
Literal
现在可以正确呈现列举值。由Bénédikt Tran修补。#11591:修复对C覆盖范围的支持
sphinx.ext.coverage
扩展名.斯蒂芬·菲纽肯的补丁。#11594:HTML主题:增强中较小设备上的水平滚动
agogo
主题.卢卡斯·恩格尔特(Lukas Engelter)的补丁。#11459:修复中对Expressc和Lambda函数的支持
sphinx.ext.autodoc.preserve_defaults
.由Bénédikt Tran修补。
测试¶
#11577:pytest:“XPass”上的测试失败。
#11577:pytest:使用“importlib”导入模式。
#11577:pytest:设置PYTHONWARNINGS=错误。
#11577:pytest:设置严格配置和严格标记。