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:
    

相关内容

热门资讯

透视脚本!WePOKer辅助软... 透视脚本!WePOKer辅助软件挂,wepoker可以透视吗,(终于清楚外挂辅助插件)是一款可以让一...
脚本辅助!wepoker的10... 脚本辅助!wepoker的10个必赢技巧,wepoker有挂吗透视软件,(关于外挂辅助下载)是一款可...
开挂透视!wepoker辅助插... 无需打开直接搜索;操作使用教程:开挂透视!wepoker辅助插件怎么用,wepoker发牌规律总结,...
辅助工具!wepoker透视辅... 您好:wepoker透视辅助器最新版本更新内容这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中...
开挂透视!wpk透视挂免费测试... 您好,微扑克辅助器免费最新版本更新内容这款游戏可以开挂的,确实是有挂的,需要了解加微【1367043...
开挂辅助工具!wpk德州最新版... 开挂辅助工具!wpk德州最新版,wepoker透视挂方法,(科技分享外挂辅助挂)是一款可以让一直输的...
开挂透视!wepoker开挂辅... 开挂透视!wepoker开挂辅助挂,wepoker辅助透视挂,(玩家科普外挂辅助挂)是一款可以让一直...
透视脚本!WePoker玩家总... 无需打开直接搜索加微信客服(136704302)咨询了解微扑克封号如何避免辅助器目前(微信:1367...
脚本辅助!wepoker好友局... wepoker好友局能不能透视是一款可以让一直输的玩家,快速成为一个“必胜”的ai辅助神器,有需要的...
透视辅助!微扑克辅助工具免费版... >>您好:微扑克辅助工具免费版苹果软件加扣扣群确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户...