Autosummary无法在本地导入包类中的方法。
创始人
2024-11-12 15:30:15
0
  1. 导入Package类中的方法时,确保使用了完全限定的名称,如Package.Class.method,而不是from Package.Class import method

  2. 在Sphinx的配置文件中加上以下两行,使得Sphinx能够正确地处理pandas中的注解:

    autodoc_mock_imports = ['pandas']
    numpydoc_show_class_members = False
    

    注意:autodoc_mock_imports用于模拟某些模块,在Sphinx文档构建过程中可以动态地替换实际的模块。因此,在使用这个配置选项时,需要将pandas添加到autodoc_mock_imports,以避免Sphinx在构建文档时尝试导入实际的pandas模块。numpydoc_show_class_members用于决定是否在文档中显示类的成员。在本例中,我们将其设置为False,因为这样可以避免Sphinx尝试在文档中显示pandas中的类成员,从而导致自动文档生成失败。

    示例代码:

    # my_module.py
    import pandas as pd
    
    class MyClass:
        """
        A simple class
        """
    
        def my_method(self, arg1, arg2):
            """
            A simple method
            
            Parameters
            ----------
            arg1 : int
                The first argument
            arg2 : str
                The second argument
            """
            pass
    
    # conf.py
    autodoc_mock_imports = ['pandas']
    numpydoc_show_class_members = False
    
    # index.rst
    .. automodule:: my_module
       :members:
    

相关内容

热门资讯

推荐十款!科乐填大坑破解版安卓... 推荐十款!科乐填大坑破解版安卓,wepoker轻量版透视方法,总结教程(有挂技巧);1、科乐填大坑破...
技术分享!广东闲来辅助神器免费... 技术分享!广东闲来辅助神器免费版,wpk官网下载链接,黑科技教程(有挂头条);1、点击下载安装,广东...
科技揭秘!福建相约13水外,线... 科技揭秘!福建相约13水外,线上德州的辅助器是什么,曝光教程(有挂秘笈)是一款可以让一直输的玩家,快...
一分钟了解!土豪联盟辅助器,w... 您好,土豪联盟辅助器这款游戏可以开挂的,确实是有挂的,需要了解加微【136704302】很多玩家在这...
玩家攻略推荐!吉祥填大坑有插件... 玩家攻略推荐!吉祥填大坑有插件吗,wpk辅助,黑科技教程(有挂方法);吉祥填大坑有插件吗AI智能教程...
教学盘点!来来拼十软件脚本,h... 教学盘点!来来拼十软件脚本,hhpoker俱乐部是干嘛的,曝光教程(有挂实锤);来来拼十软件脚本是一...
科技通报!微信闲来神器软件下载... 科技通报!微信闲来神器软件下载,aapoker插件下载,介绍教程(有挂透明挂),微信闲来神器软件下载...
总算明白!七千在线辅助,德州来... 总算明白!七千在线辅助,德州来玩辅助器,专业教程(有挂工具);1、总算明白!七千在线辅助,德州来玩辅...
分享给玩家!三哥玩app辅助,... 分享给玩家!三哥玩app辅助,哈糖大菠萝辅助器,2025新版教程(有挂解惑),哈糖大菠萝辅助是用手机...
盘点几款!欢乐对决脚本,wep... 您好,欢乐对决脚本这款游戏可以开挂的,确实是有挂的,需要了解加微【136704302】很多玩家在这款...