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:
    

相关内容

热门资讯

总算了解!红龙扑克电脑模拟器,... 总算了解!红龙扑克电脑模拟器,wpk透明挂,规律教程(真是存在有挂);小薇(透视辅助)致您一封信;亲...
科技揭秘!pokerwoeld... 科技揭秘!pokerwoeld安卓下载,德州之星有辅助挂,可靠教程(最初真的有挂)德州之星有辅助挂辅...
分享开挂内幕!德扑之星软件透明... 分享开挂内幕!德扑之星软件透明软件,aapoker有挂,微扑克教程(最初存在有挂)1、不需要AI权限...
详细说明!wpk辅助实时策略建... 详细说明!wpk辅助实时策略建议,微扑克ai机器人,分享教程(真是有挂)1、许多玩家不知道微扑克ai...
发现一款!德扑之星app发牌规... 发现一款!德扑之星app发牌规律,德州ai人工智能,揭秘攻略(一贯是有挂)1、许多玩家不知道德州ai...
实测发现!gg发牌控制,微扑克... 您好,微扑克全自动机器人这款游戏可以开挂的,确实是有挂的,需要了解加微【136704302】很多玩家...
发现一款!wepoke辅助插件... 发现一款!wepoke辅助插件,wpk德州透视辅助,技巧教程(竟然真的是有挂)1.wpk德州透视辅助...
玩家必看!wpk这个软件真实吗... 玩家必看!wpk这个软件真实吗,微扑克辅助挂,详细教程(一直存在有挂);人气非常高,ai更新快且高清...
玩家必备科普!微扑克必胜技巧,... 玩家必备科普!微扑克必胜技巧,德扑起手牌胜率图,实用技巧(一贯真的是有挂);玩家必备科普!微扑克必胜...
详细说明!德扑之星记分牌有什么... 详细说明!德扑之星记分牌有什么用,wepoke智能ai,切实教程(先前真的是有挂)是一款可以让一直输...