Sphinx 和 TypedDict

问题描述 投票:0回答:1

我在代码中定义了一个

TypedDict
,如下所示:

class VectorDict(TypedDict):
    x: float
    y: float
    z: float

当我生成文档时,我得到以下结果:

如何抑制

->
之后的所有内容和/或修改它?

python python-sphinx python-typing
1个回答
1
投票

解决方案是添加文档字符串:

class VectorDict(TypedDict):   
    """
    Description here
    """

    x: float
    y: float
    z: float

由此我得到:

enter image description here

© www.soinside.com 2019 - 2024. All rights reserved.