清理 sphinx-doc protobuf 类型

Question

我觉得我之前已经解决了这个问题，但它不再起作用了，我正在开发一些基于 protobuf 和 grpc 的代码，并且在文档中所有类型都非常混乱：

create_session（名称：str，路径：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 似乎无法将注释中的类型链接到它们的定义，除非它们已被导入到文件中，即使注释是前向引用或字符串也是如此。