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:
    

相关内容

热门资讯

科技通报!福建天天开心攻略,天... 科技通报!福建天天开心攻略,天天微友助手破解版,详细app(有挂详细)1、天天微友助手破解版公共底牌...
分享一款!点我休闲辅助器,大唐... 分享一款!点我休闲辅助器,大唐山西辅助软件,详细方法(有挂详细)1、打开软件启动之后找到中间准星的标...
热点推荐!创思维激K辅助器开挂... 热点推荐!创思维激K辅助器开挂,情怀国粹麻将神器,详细技巧(有挂讲解)1、创思维激K辅助器开挂有没有...
程序员教你!福建天天开心辅助工... 程序员教你!福建天天开心辅助工具,博雅西元红河辅助脚本,详细技巧(有挂头条)1)福建天天开心辅助工具...
终于懂了!多乐够级辅助软件,赣... 终于懂了!多乐够级辅助软件,赣牌圈破解器,详细方法(有挂分析)1、完成多乐够级辅助软件辅助器v3.3...
记者揭秘!蛮王辅助,赖子三加一... 记者揭秘!蛮王辅助,赖子三加一辅助,详细器(存在有挂)1、实时赖子三加一辅助透视辅助更新:用户可以随...
详细说明!吉祥填大坑辅助器攻略... 详细说明!吉祥填大坑辅助器攻略,菠萝辅助破解版,详细app(有挂实锤)1、很好的工具软件,可以解锁游...
专业讨论!福建天天开心辅助工具... 专业讨论!福建天天开心辅助工具下载,九九联盟后台可以操作吗,详细插件(有挂方针)1)福建天天开心辅助...
热点推荐!微信小程序加速脚本,... 热点推荐!微信小程序加速脚本,江西微乐家乡辅助脚本,详细神器(有挂神器)1、江西微乐家乡辅助脚本免费...
揭秘关于!九酷众娱辅助,微信小... 揭秘关于!九酷众娱辅助,微信小程序辅助有哪些,详细app(的确有挂)1、下载好微信小程序辅助有哪些正...