我正在做一个类型声明。例如:
from typing import Tuple
Type1 = Tuple[str, float]
我希望 Sphinx 像函数声明一样记录此声明。我该怎么做?预先感谢。
如果我创建文档并添加常用描述,结果是这些类型的声明显示为纯文本,而不是特殊内容。
规范的 Python 方法是使用
PEP-653中的
TypeAlias
:
#
# Python >= 3.12
#
#: Funny type that is mixing strings and floats - sounds like JavaScript programming!
type NumberOrString = Tuple[str, float]
#
# 3.10 <= Python < 3.12
#
#: Funny type that is mixing strings and floats - sounds like JavaScript programming!
NumberOrString: TypeAlias = Tuple[str, float]
在撰写本文时,自动生成文档的 Sphinx 组件,autodoc,尚不支持 TypeAlias。