Sphinx7.3¶

版本7.3.7（2024年4月19日发布）¶

错误已修复¶

#12299：延迟加载通过入口点定义的主题，直到用户或子主题显式使用它们。Adam Turner的补丁。
#12305：返回默认值 theme.get_config() 具有不支持的主题配置部分。Adam Turner的补丁。

版本7.3.6（2024年4月17日发布）¶

错误已修复¶

#12295：重新输出C和C++域中的所有AST类型。Adam Turner的补丁。
#12295：从重新出口各种对象 sphinx.domains.python._annotations 在 sphinx.domains.python .补丁由Jacob Chesslo和Adam Turner制作。

版本7.3.5（2024年4月17日发布）¶

错误已修复¶

#12295：从重新出口各种对象 sphinx.domains.python._object 在 sphinx.domains.python .补丁由Jacob Chesslo和Adam Turner制作。

版本7.3.4（2024年4月17日发布）¶

错误已修复¶

处理案件时 Any 不是 type . Adam Turner的补丁。

版本7.3.3（2024年4月17日发布）¶

错误已修复¶

#12290：使用设置配置值时修复误报警告 Any 作为该值默认值以外的类型的有效类型。Adam Turner的补丁。

版本7.3.2（2024年4月17日发布）¶

错误已修复¶

预加载通过入口点定义的所有主题。Adam Turner的补丁。
修复之间的不良互动 'Furo' 主题和配置值的新样式。Adam Turner的补丁。

版本7.3.1（2024年4月17日发布）¶

依赖关系¶

需要 tomli 在Python 3.10及更早版本上。Adam Turner的补丁。

版本7.3.0（2024年4月16日发布）¶

依赖关系¶

#11858：将Thomaster支持的最低版本增加到0.7.14。Adam Turner的补丁。
#11411：支持 Docutils 0.21 . Adam Turner的补丁。
#12012：使用 types-docutils 而不是 docutils-stubs .

弃用¶

#11693：支持老式 Makefile 和 make.bat 输出 sphinx-quickstart ，以及相关选项 -M , -m , --no-use-make-mode ，而且 --use-make-mode .
#11285：直接访问 sphinx.testing.util.SphinxTestApp._status 或 sphinx.testing.util.SphinxTestApp._warning 已经过时了使用公共属性 sphinx.testing.util.SphinxTestApp.status 和 sphinx.testing.util.SphinxTestApp.warning 而不是.由Bénédikt Tran修补。
测试： sphinx.testing.util.strip_escseq() 被反对支持 sphinx.util.console.strip_colors() .由Bénédikt Tran修补。

功能添加¶

#12265：通过支持主题配置 theme.toml .
#11701：HTML搜索：采用新的 <search> 元素由Bénédikt Tran修补。
#11776：将长选项名称添加到 sphinx-build .由Hugo van Kemenade、Adam Turner、Bénédikt Tran和Ezio Melotti制作补丁。
筹办 sphinx-build 分组选项。Adam Turner的补丁。
#11855：延迟配置值的计算。Adam Turner的补丁。
添加 :no-search: 作为的别名 :nosearch: 元数据字段。Adam Turner的补丁。
#11803：autodoc：使用覆盖的 __repr__() 如果已定义，则以enum形式存在。由Shengyu Zhang提供补丁。
#11825：允许在手册页角色中自定义目标。尼古拉斯·皮格纳特（Nicolas Peugnet）的补丁。
#11892：提高了解决C++域中交叉引用时的性能。补丁由Ottlan Korneychuk。
#11905：添加 versionremoved 指令。Hugo van Kemenade，Adam Turner和C.A.M. Gerlach的补丁。
#11981：使用改进签名的呈现 slice 语法，例如， def foo(arg: np.float64[:,:]) -> None: ... .
手册页构建器现在添加 OSC 8 使用 groff 设备控制命令。
#11015：改变文本 versionadded 指令从 New in [...] 到 Added in [...] .由Bénédikt Tran修补。
#12131：添加 show_warning_types 配置选项。克里斯·休厄尔（Chris Sewell）的补丁。
#12193：改进 external 未知角色的警告。特别是，如果错误使用对象类型，请建议相关角色名称。克里斯·休厄尔（Chris Sewell）的补丁。
添加公共类型别名 sphinx.util.typing.ExtensionMetadata .扩展开发人员可以使用这来注释其 setup 功能克里斯·休厄尔（Chris Sewell）的补丁。

错误已修复¶

#11668：当出现时，引发有用的错误 theme.conf 失踪了由Vinay Sajip修补。
#11622：确保钥匙的顺序 searchindex.js 是确定性的。补丁作者：Pietro Albini。
#11617：当使用写入警告文件时，将从输出中剥离ASIC控制序列 -w .由Bénédikt Tran修补。
#11666：跳过中的所有隐藏目录 CatalogRepository.pofiles .补丁由Aryaz Eghbali制作。
#9686：html构建器：修复标题中出现方程时MathJax延迟加载的问题。由Bénédikt Tran修补。
#11483：singlehtml构建器：修复索引不包含任何数学方程时MathJax懒惰加载。由Bénédikt Tran修补。
#11697：HTML搜索：添加“noindex”Meta机器人标签。詹姆斯·艾迪生的补丁。
#11678：修复可能的 ZeroDivisionError 在 sphinx.ext.coverage .斯蒂芬·菲纽肯的补丁。
#11756：LaTeX：由于丢失，最近的TeXLive出现构建错误 substitutefont 包（如果使用则会触发 fontenc 与 T2A 选项和文档语言不是西里尔语言）。补丁：让-弗朗索瓦·B。
#11675：修复不支持ASIC控制序列的环境中进度条的渲染。由Bénédikt Tran修补。
#11861：将更多类型列为不正确的白名单 __module__ 属性Adam Turner的补丁。
#11715：申请 tls_verify 和 tls_cacerts config以 ImageDownloader .尼克·图兰的补丁。
允许在组名称中使用连字符 productionlist 交叉引用。Adam Turner的补丁。
#11433：添加了 linkcheck_allow_unauthorized 配置选项。将此选项设置为 False 将HTT401（未经授权）服务器响应报告为已损坏。詹姆斯·艾迪生的补丁。
#11868：linkcheck：添加了一个独特的 timeout 报告状态代码。这可以通过设置来启用 linkcheck_report_timeouts_as_broken 到 False .詹姆斯·艾迪生的补丁。
#11869：刷新 linkcheck_timeout 设置.詹姆斯·艾迪生的补丁。
#11874：配置默认30秒值 linkcheck_timeout .詹姆斯·艾迪生的补丁。
#11886：打印Jinja 2模板路径链 TemplateNotFound 例外.科林·马夸特的补丁。
#11598：请勿在EPub渲染中使用资源的URL中的查询组件。David Runge的补丁。
#11904：解析注释时支持一元减法。詹姆斯·艾迪生的补丁。
#11925;黑名单 sphinxprettysearchresults 扩展;它提供的功能已合并到Sphinx v2.0.0中。詹姆斯·艾迪生的补丁。
#11917：修复Python 3.9中带注释的继承成员的呈现。珍妮特·卡森的补丁。
#11935：C域：修复命名空间-流行上下文。弗兰克·达纳（Frank Dana）的补丁。
#11923：当并行构建失败时避免僵尸进程。由Felix von Drigalski制作的补丁。
#11353：支持从mixin或数据类型继承的列举类。由Bénédikt Tran修补。
#11962：使用时修复目标分辨率 :paramtype: 领域的由Bénédikt Tran修补。
#11944：在搜索预览中使用锚点。威尔·拉钱斯（Will Lachance）的补丁。
#12008：修复区分大小写的查找 std:label interphinx库存中的名字。迈克尔·戈尔兹的补丁。
#11958：HTML搜索：修复部分匹配项，删除完全匹配项。威廉·拉钱斯（William Lachance）的补丁。
#11959：修复单词出现在标题和文档中时的多个术语匹配。威尔·拉钱斯（Will Lachance）的补丁。
#11474：修复doctree缓存在某些情况下导致文件无法重建的问题，例如，当 numfig 是 True .由Bénédikt Tran修补。
#11278：autodoc：修复的渲染 functools.singledispatchmethod 结合 @classmethod .由Bénédikt Tran修补。
#11894：如果使用htmlHelp生成器构建，请勿将检查和添加到css文件。由ReduerK akiM修补。
#12052：删除 <script> 和 <style> 来自搜索结果摘要片段内容的标签。詹姆斯·艾迪生的补丁。
#11578：HTML搜索：在其他结果之后排序非主索引条目。布拉德·金的补丁。
#12147：autosummary：修复了当中指定多个后缀时可能使用错误的文件扩展名的错误 source_suffix .由Sutou Kouhei修补。
#10786：改进复制文件时的错误消息（例如，资产）在Sphinx执行期间被删除。由Bénédikt Tran修补。
#12040：HTML搜索：确保用户搜索查询部分匹配的文档标题包含在搜索结果中。詹姆斯·艾迪生的补丁。
#11970：singlehtml构建器：使目标URIs成为同一文档引用 RFC 3986, §4.4 ，例如， index.html#foo 成为 #foo . Eric Norige的补丁。
#12271：部分恢复Docutils的 r9562 修复EPub文件。Adam Turner的补丁。
#12253：在远程图像转换后下载缓存中逸出保留路径字符。补丁由詹姆斯·艾迪生和亚当·特纳完成。

测试¶

将测试重新组织到目录中。Adam Turner的补丁。
清理全球状态 SphinxTestApp . Adam Turner的补丁。
#11285： pytest.mark.sphinx() 和 sphinx.testing.util.SphinxTestApp 接受 warningiserror , keep_going 和 verbosity 作为关键字参数。由Bénédikt Tran修补。
#11285: sphinx.testing.util.SphinxTestApp status and warning arguments are checked to be io.StringIO objects (the public API incorrectly assumed this without checking it). Patch by Bénédikt Tran.
报告结果 test_run_epubcheck 作为 skipped 而不是 success 当Java或 epubcheck 不可用。
为测试HTTP（S）服务器使用未使用的端口号的动态分配。作为副作用，这消除了对测试服务器锁文件的需要，这意味着任何剩余的 tests/test-server.lock 可以安全地删除文件。