记录用户使用Sphinx创建的类型声明

Question

我正在做一个类型声明。例如:

from typing import Tuple
Type1 = Tuple[str, float]

我希望Sphinx像记录函数声明一样记录这个声明。我该怎么做呢?提前谢谢。

如果我构建文档并添加通常的描述，结果是这些类型的声明显示为纯文本，而不是特殊的内容。

Answer 1

规范的Python方法是使用PEP-653中的TypeAlias:

#: Funny type that is mixing strings and floats - sounds like JavaScript programming!
Type1: TypeAlias = Tuple[str, float]

在Python 3.10中添加。

在写这篇文章的时候，Sphinx的自动生成文档组件autodoc还不支持TypeAlias。