如何让 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

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)