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:
    

相关内容

热门资讯

第2分钟讲解!新超凡软件辅助(... 第2分钟讲解!新超凡软件辅助(辅助挂)其实是有挂的(黑科技教程开挂辅助下载) 【无需打开直接搜索加薇...
第4分钟发现!微信小程序财神十... 第4分钟发现!微信小程序财神十三章特殊牌(辅助挂)原来真的有挂(专业教程开挂辅助软件)微信小程序财神...
第一分钟科普!决战卡五星辅助器... 第一分钟科普!决战卡五星辅助器下载(辅助挂)一贯真的有挂(新2026教程开挂辅助平台)决战卡五星辅助...
第3分钟辅助!中至辅助插件最简... 第3分钟辅助!中至辅助插件最简单三哥步骤(辅助挂)一直是有挂的(必胜教程开挂辅助工具) 了解更多开挂...
第五分钟了解!新九天互游辅助(... 第五分钟了解!新九天互游辅助(辅助挂)一直是有挂的(第三方教程开挂辅助工具) 【无需打开直接搜索加薇...
第九分钟辅助!福建兄弟13水插... 【亲,福建兄弟13水插件 这款游戏可以开挂的,确实是有挂的,很多玩家在这款福建兄弟13水插件中打牌都...
八分钟辅助!小程序微乐辅助器2... 八分钟辅助!小程序微乐辅助器2.0(辅助挂)一直确实有挂(解密教程开挂辅助工具) 【无需打开直接搜索...
九分钟辅助!爱玩修改器(辅助挂... 大家好,今天小编来为大家解答爱玩修改器这个问题咨询软件客服可以免费测试直接加微信(136704302...
第9分钟科普!老友记辅助器(辅... 第9分钟科普!老友记辅助器(辅助挂)果然是有挂(可靠教程开挂辅助下载)1、下载安装好老友记辅助器,进...
第2分钟了解!悠闲游戏辅助(辅... >>您好:悠闲游戏辅助确实是有挂的,很多玩家在这款悠闲游戏辅助游戏中打牌都会发现很多用户的牌特别好,...