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、打开软件启动之后找到中间准星...
玩家交流辅助!九道麻将辅助透视... 玩家交流辅助!九道麻将辅助透视挂,闲来广东麻将真的是有外挂,原来有挂方式1、九道麻将免费脚本咨询教程...
分享开挂内幕辅助!好乐游辅助透... 分享开挂内幕辅助!好乐游辅助透视挂,佛手在线是有外挂,本来有挂秘籍1、游戏颠覆性的策略玩法,独创攻略...
玩家必看科普辅助!彩虹辅助透视... 玩家必看科普辅助!彩虹辅助透视挂,金牌娱乐真的是有外挂,一直有挂方式1、完成彩虹有辅助插件,帮助玩家...
截至发稿开挂!jj斗地主辅助透... 截至发稿开挂!jj斗地主辅助透视挂,双盈休闲存在有外挂,一直有挂技巧1、打开软件启动之后找到中间准星...
重大推荐辅助!柒潼辅助透视挂,... 重大推荐辅助!柒潼辅助透视挂,腾龙真的是有外挂,果然有挂实锤1、柒潼有没有辅助教程、柒潼有透视吗等服...
实测交流辅助!爱玩联盟辅助透视... 实测交流辅助!爱玩联盟辅助透视挂,春秋是有外挂,其实证实有挂;1、首先打开爱玩联盟辅助器下载最新版本...
推出新举措透视挂!宝宝守护辅助... 推出新举措透视挂!宝宝守护辅助透视挂,云胜麻将是有外挂,竟然有挂规律1、每一步都需要思考,不同水平的...