如何让 Sphinx 使用来自 Python 个存根文件的类型注释
How to get Sphinx to use type annotations from Python stub files
我使用存根文件(即“*.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 源文件混乱。然而,最简单的解决方案(目前)似乎是无论如何都将类型信息放入源文件并取消存根文件。
我使用存根文件(即“*.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 源文件混乱。然而,最简单的解决方案(目前)似乎是无论如何都将类型信息放入源文件并取消存根文件。