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:
    

相关内容

热门资讯

玩家必看秘籍!聚友联盟辅助器,... 您好:聚友联盟辅助器这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌特...
技巧知识分享!好友赣南新版本脚... 技巧知识分享!好友赣南新版本脚本,德普之星透视辅助软件激活码,2025新版总结(新版有挂);好友赣南...
玩家必备教程!海贝之城有辅助吗... 玩家必备教程!海贝之城有辅助吗,红龙poker辅助平台,必胜教程(有挂解密);1、让任何用户在无需A...
必看攻略!微乐陕西小程序破解器... 必看攻略!微乐陕西小程序破解器下载,约局吧辅助器,线上教程(存在有挂)是一款可以让一直输的玩家,快速...
大家学习交流!hhpoker大... 大家学习交流!hhpoker大菠萝有没有作比,wepoker免费脚本咨询,切实教程(有挂秘笈);1、...
实测交流!四川途游小程序辅助,... 实测交流!四川途游小程序辅助,hh poker辅助器先试用,安装教程(有挂猫腻);最新版2026是一...
我来教教你!陕西挖坑辅助,po... 我来教教你!陕西挖坑辅助,pokeplus脚本,解密教程(有挂工具)是一款可以让一直输的玩家,快速成...
实测交流!佛手十三道辅助,德普... 实测交流!佛手十三道辅助,德普软件,详细教程(有挂分析);佛手十三道辅助是一项佛手十三道辅助软件透明...
玩家必看分享!开心十三张有没有... 玩家必看分享!开心十三张有没有挂,wepoker开脚本视频,AA德州教程(有挂方法);开心十三张有没...
9分钟了解!小程序游戏修改器辅... 【福星临门,好运相随】;9分钟了解!小程序游戏修改器辅助,哈糖大菠萝有挂吗,安装教程(真的有挂);暗...