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模拟器技法!wejoke... WPK模拟器技法!wejoker辅助机器人,德州微扑克竟然有开挂技巧1、让任何用户在无需wejoke...
WPK四人法子!红龙poker... WPK四人法子!红龙poker透视工具,德州微扑克好像是有辅助器技巧1、完成红龙poker透视工具有...
WPK俱乐部妙招!aapoke... WPK俱乐部妙招!aapoker可以开挂吗,德州微扑克好像存在有透视挂教程aapoker可以开挂吗透...
WPK作弊妙计!wepoker... WPK作弊妙计!wepoker破解游戏盒子,德州微扑克本来真的是有透视app小薇(辅助器软件下载)致...
WPK真假法门!aapoker... WPK真假法门!aapoker透视脚本安装包,德州微扑克竟然存在有开挂技巧aapoker透视脚本安装...
WPK辅助器绝活儿!wepok... WPK辅助器绝活儿!wepoker有透视底牌吗,德州微扑克一贯有开挂工具1、wepoker有透视底牌...
WPK私人局法子!wepoke... WPK私人局法子!wepoker软件靠谱么,德州微扑克好像是真的有透视挂插件进入游戏-大厅左侧-新手...
WPK方法课程!wepoker... WPK方法课程!wepoker透视脚本苹果,德州微扑克真是有辅助器脚本1、在wepoker透视脚本苹...
WPK私人局学习!wepoke... 您好,wepoker私人局俱乐部辅助这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704...
WPK工具方案!wepoker... WPK工具方案!wepoker免费透视脚本,德州微扑克果然是有开挂技巧1、wepoker免费透视脚本...