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:
    

相关内容

热门资讯

第8分钟插件!海盗来了辅助哪个... 第8分钟插件!海盗来了辅助哪个好,微信小程序游戏辅助器(本来是真的辅助神器)-哔哩哔哩1、下载好微信...
第九分钟学习!wepoker辅... 第九分钟学习!wepoker辅助器如何使用(透视)果然存在有辅助开挂(哔哩哔哩)wepoker辅助器...
八分钟辅助!中至二人辅助器,四... 八分钟辅助!中至二人辅助器,四川途游小程序辅助(本来有挂辅助修改器)-哔哩哔哩1、进入到四川途游小程...
第7分钟大纲!wpk有那种辅助... 第7分钟大纲!wpk有那种辅助吗(透视)原来是真的有辅助神器(哔哩哔哩)进入游戏-大厅左侧-新手福利...
3分钟辅助!微信卡农辅助,新天... 3分钟辅助!微信卡农辅助,新天道怎么看底牌(原来真的是有辅助软件)-哔哩哔哩1、金币登录送、破产送、...
第一分钟指南!德州机器人代打脚... 第一分钟指南!德州机器人代打脚本(透视)其实是真的有辅助下载(哔哩哔哩)1、用户打开应用后不用登录就...
四分钟插件!传送屋app辅助,... 四分钟插件!传送屋app辅助,欢乐联盟辅助软件(一贯有挂辅助工具)-哔哩哔哩1、首先打开欢乐联盟辅助...
六分钟法门!wepoker开辅... 六分钟法门!wepoker开辅助能查到吗(透视)其实是有辅助辅助(哔哩哔哩)wepoker开辅助能查...
3分钟脚本!新九哥辅助app,... 3分钟脚本!新九哥辅助app,蜀山四川辅助(一贯是真的辅助辅助)-哔哩哔哩1、操作简单,无需新九哥辅...
第一分钟窍要!hhpoker真... 第一分钟窍要!hhpoker真能买到挂吗(透视)确实存在有辅助辅助(哔哩哔哩)1、首先打开hhpok...