如何让Sphinx使用Python存根文件中的类型注释



我在项目中使用存根文件(即"*.pyi"文件(来管理类型注释。我的文档字符串在实际的源文件中。我安装了sphinx-autodoc-annotation来让Sphinx查看类型注释,但它不查看存根文件。当通过Sphinx生成文档时,如何从存根文件中提取类型?

foo.pyi

class Foo:
def bar(self, baz: str) -> str:
...

foo.py

class Foo:
def bar(self, baz):
"""Does some cool stuff
:param baz: some parameter that we do stuff with
"""
return baz

我之所以使用存根文件,是因为我想避免将Python源文件与类型信息混淆。然而,(目前(最简单的解决方案似乎是将类型信息放入源文件中,并去掉存根文件。

相关内容

  • 没有找到相关文章

最新更新