清理sphinx-doc原型类型

Question

我觉得我之前已经弄清楚了但是它又不起作用了，我正在开发一些基于protobuf和grpc的代码在文档中所有的类型都很混乱:

create_session(name: str, path: str, file_type:= 0, sample_rate:= 2, bit_depth:= 2, io_setting:= 1, is_interleaved: bool = True)

这是从下面的函数在我的源代码

import ptsl.PTSL_pb2 as pt # my grpc-tools generated type header
# yada yada yada
def create_session(self,
name: str,
path: str,
file_type: 'SessionAudioFormat' = pt.SAF_WAVE,
sample_rate: 'SampleRate' = pt.SR_48000,
bit_depth: 'BitDepth' = pt.Bit24,
io_setting: 'IOSettings' = pt.IO_Last,
is_interleaved: bool = True) -> None:
# etc...

源代码中的类型注释被转换为该类型的实例，而不仅仅是链接到文档其余部分的引用。是否有一种方法可以使文档解析到真正的类型名称，并链接到我所做的那些类型的文档(像任何其他类型一样)?

Answer 1

我的错误，我忘记了在顶部导入类型。Sphinx似乎无法将注释中的类型链接到它们的定义，除非它们被导入到文件中，即使注释是前向引用或字符串。