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:
    

相关内容

热门资讯

玩家必看透视器!牛将军互娱透视... 玩家必看透视器!牛将军互娱透视器多功能AI攻略,牛将军互娱一直是真的有透视器攻略一、牛将军互娱可以开...
最新研发外挂!嘻嘻娱乐外挂多功... 最新研发外挂!嘻嘻娱乐外挂多功能AI脚本,嘻嘻娱乐原来真的有外挂脚本1、金币登录送、破产送、升级送、...
一分钟教会你辅助器!鲨鱼众娱辅... 一分钟教会你辅助器!鲨鱼众娱辅助器多功能AI攻略,鲨鱼众娱真是有辅助器攻略1、超多福利:超高返利,海...
揭秘几款辅助器!九游互娱辅助器... 揭秘几款辅助器!九游互娱辅助器多功能AI攻略,九游互娱果然真的是有辅助器攻略1、九游互娱公共底牌简单...
每日必看推荐开挂!欢盈娱乐开挂... 每日必看推荐开挂!欢盈娱乐开挂多功能AI软件,欢盈娱乐真是是有开挂软件1、完成欢盈娱乐有辅助插件,帮...
一分钟揭秘透视挂!新久久透视挂... 一分钟揭秘透视挂!新久久透视挂多功能AI教程,新久久原来真的有透视挂教程一分钟揭秘透视挂!新久久透视...
解密关于开挂!大大娱乐开挂多功... 解密关于开挂!大大娱乐开挂多功能AI方法,大大娱乐一直是真的有开挂方法亲,关键说明,大大娱乐透视脚本...
一起来讨论辅助器!卡尔辅助器多... 一起来讨论辅助器!卡尔辅助器多功能AI技巧,卡尔都是有辅助器技巧1、下载好卡尔脚本下载之后点击打开,...
交流学习经验辅助器!闲玩娱乐鱼... 交流学习经验辅助器!闲玩娱乐鱼虾蟹辅助器多功能AI方法,闲玩娱乐鱼虾蟹切实真的有辅助器方法进入游戏-...
程序员教你开挂!传奇互娱开挂多... 程序员教你开挂!传奇互娱开挂多功能AI技巧,传奇互娱确实有开挂技巧1、下载好传奇互娱脚本下载之后点击...