Sphinx 和 TypedDict

Question

我在我的代码中定义了一个 TypedDict，如下所示：

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

当我生成文档时，我得到以下结果：

-> and/or 修改后如何抑制所有内容？

Answer 1

解决方法是添加文档字符串：

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

    x: float
    y: float
    z: float

有了这个我得到：