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、完成贪吃蛇有辅助插件...
重大通报!个人棋牌辅助器功能教... 重大通报!个人棋牌辅助器功能教程,个人棋牌其实真的是有辅助器教程(有辅助挂教学)1、个人棋牌破解器简...
一分钟教你!大众茶苑透视挂功能... 一分钟教你!大众茶苑透视挂功能工具,大众茶苑总是是真的有透视挂工具(有辅助挂辅助)1、不需要AI权限...
技术分享!潮汕掌上娱开挂功能教... 技术分享!潮汕掌上娱开挂功能教程,潮汕掌上娱确实是真的有开挂教程(有辅助挂透视)1、用户打开应用后不...
每日必备!玄龙大厅开挂功能插件... 每日必备!玄龙大厅开挂功能插件,玄龙大厅一直是真的有开挂插件(有辅助挂解密)1、任何玄龙大厅透视是真...
科普常识!163棋牌透视功能攻... 科普常识!163棋牌透视功能攻略,163棋牌果然真的是有透视攻略(有辅助挂功能)1、163棋牌公共底...
教程辅助!星星娱乐透视挂功能技... 教程辅助!星星娱乐透视挂功能技巧,星星娱乐总是真的有透视挂技巧(有辅助挂详情)1、星星娱乐有没有辅助...
记者爆料!八闽状元郎开挂功能攻... 记者爆料!八闽状元郎开挂功能攻略,八闽状元郎其实是真的有开挂攻略(有辅助挂秘籍)八闽状元郎透视方法中...
最新技巧!跑得快透视功能教程,... 最新技巧!跑得快透视功能教程,跑得快本来是有透视教程(有辅助挂app)1、许多玩家不知道跑得快辅助怎...