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:
    

相关内容

热门资讯

此事备受玩家关注"w... 此事备受玩家关注"wepoker专用辅助程序"果然存在有辅助器(哔哩哔哩)1、超多福利:超高返利,海...
透视详情"约局吧游戏... 透视详情"约局吧游戏挂"切实有辅助插件(哔哩哔哩)1、任何约局吧游戏挂透视是真的假的的玩家都可以机会...
第三方技巧"微信小程... 第三方技巧"微信小程序雀神修改"总是是有辅助器(哔哩哔哩)1、完成微信小程序雀神修改辅助器v3.3的...
透视普及"wepok... 透视普及"wepoker私人局辅助器怎么用"原来存在有辅助技巧(哔哩哔哩);1、首先打开wepoke...
有了最新消息"小程序... 有了最新消息"小程序跑的快辅助器"确实存在有辅助器(哔哩哔哩)1)小程序跑的快辅助器免费钻石:进一步...
透视揭幕"pokem... 透视揭幕"pokemmo脚本辅助下载"好像真的有辅助脚本(哔哩哔哩)1、操作简单,无需pokemmo...
黑科技技巧"决战卡五... 您好,决战卡五星游戏辅助器这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很...
透视详情"大菠萝免费... 透视详情"大菠萝免费辅助"原来是真的辅助器(哔哩哔哩)1、打开软件启动之后找到中间准星的标志长按。2...
现就发布提示"卡五星... 现就发布提示"卡五星游戏有挂吗"竟然是有辅助攻略(哔哩哔哩)1、完成卡五星游戏有挂吗辅助器v3.3的...
透视教你"hhpok... 透视教你"hhpoker辅助挂是真的吗"总是真的是有辅助挂(哔哩哔哩)1、玩家可以在hhpoker辅...