微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决如何让 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 举报,一经查实,本站将立刻删除。