You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在Sphinx文档字符串中引用泛型类型Collection[Championship]

解决Sphinx文档字符串中泛型类的引用问题
  • 正确的写法需将泛型类和类型参数分别用:class:指令包裹,确保Sphinx能识别并生成跳转链接:

    :rtype: :class:`.Collection`[:class:`.Championship`]
    

    这种写法会让.Collection和.Championship都被解析为可点击的类引用。

  • 你之前尝试的Collection[.Championship]写法中,.Championship未被:class:指令包裹,Sphinx无法将其识别为类文档链接,只能显示纯文本。

  • 额外注意:需确保Sphinx配置中启用了sphinx.ext.autodoc扩展,且Collection与Championship类已被正确文档化,Sphinx能定位到它们的文档位置。

内容的提问来源于stack exchange,提问作者Stuart Yellow

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.01 06:25:35