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、很好的工具软件,可以解锁游戏...
第一分钟辅助!好友赣南辅助器,... 第一分钟辅助!好友赣南辅助器,切实存在有辅助神器(有挂分享)好友赣南辅助器是不是有人用挂微扑克wpk...
第十分钟辅助!先锋大厅辅助,本... 第十分钟辅助!先锋大厅辅助,本来真的是有辅助挂(有挂秘诀)1、打开软件启动之后找到中间准星的标志长按...
7分钟辅助!微乐自建房辅助神器... 7分钟辅助!微乐自建房辅助神器怎么安装,原来真的有辅助神器(有挂详情)1、起透看视 微乐自建房辅助神...
一分钟辅助!情怀手机麻将辅助器... 一分钟辅助!情怀手机麻将辅助器,好像存在有辅助神器(讲解有挂)1、全新机制【情怀手机麻将辅助器ai辅...
第五分钟辅助!微乐自建房脚本免... 第五分钟辅助!微乐自建房脚本免费入口,竟然真的是有辅助软件(真的有挂)1、微乐自建房脚本免费入口有没...
3分钟辅助!决战卡五星辅助软件... 3分钟辅助!决战卡五星辅助软件哪个好用,竟然存在有辅助教程(揭秘有挂)1、在决战卡五星辅助软件哪个好...
五分钟辅助!微乐家乡游戏攻略,... 五分钟辅助!微乐家乡游戏攻略,好像是有辅助软件(有挂技巧)1、上手简单,内置详细流程视频教学,新手小...
1分钟辅助!一乐棋牌辅助器,其... 1分钟辅助!一乐棋牌辅助器,其实真的是有辅助工具(有挂详情)1、许多玩家不知道一乐棋牌辅助器辅助怎么...