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:
    

相关内容

热门资讯

两分钟辅助!开心泉州小程序开挂... 两分钟辅助!开心泉州小程序开挂有什么技巧,原来真的是有辅助插件(有挂教学)开心泉州小程序开挂有什么技...
七分钟辅助!奇迹脚本辅助,真是... 七分钟辅助!奇迹脚本辅助,真是有辅助软件(确实有挂)1、超多福利:超高返利,海量正版游戏,奇迹脚本辅...
一分钟辅助!天天贵阳智能辅助器... 一分钟辅助!天天贵阳智能辅助器,原来是有辅助脚本(真的有挂)亲,关键说明,天天贵阳智能辅助器透视脚本...
3分钟辅助!一起宁德钓蟹黑科技... 3分钟辅助!一起宁德钓蟹黑科技辅助软件推荐,其实真的有辅助挂(有挂存在)1、玩家可以在一起宁德钓蟹黑...
第二分钟辅助!大菠萝789辅助... 第二分钟辅助!大菠萝789辅助器下载,原来存在有辅助挂(存在有挂)运大菠萝789辅助器下载辅助工具,...
3分钟辅助!科乐填坑辅助,原来... 3分钟辅助!科乐填坑辅助,原来真的是有辅助器(有挂方略)1、下载好科乐填坑辅助透视辅助下载之后点击打...
3分钟辅助!潮友会透视辅助教程... 3分钟辅助!潮友会透视辅助教程,果然存在有辅助器(有挂辅助)亲,关键说明,潮友会透视辅助教程透视脚本...
4分钟辅助!福建兄弟十三冰修改... 4分钟辅助!福建兄弟十三冰修改器,本来真的是有辅助app(有挂讲解)1、游戏颠覆性的策略玩法,独创攻...
第二分钟辅助!wepoker插... 第二分钟辅助!wepoker插件程序,真是是真的有辅助技巧(有挂细节)1、不需要AI权限,帮助你快速...
1分钟辅助!悠悠互娱辅助,真是... 1分钟辅助!悠悠互娱辅助,真是是有辅助神器(有挂解密)悠悠互娱辅助透视方法中分为三种模型:悠悠互娱辅...