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:
    

相关内容

热门资讯

透视神器!pokemmo手机版... 透视神器!pokemmo手机版修改器,淘宝的微乐辅助是真的吗,解密脚本(有挂猫腻)-哔哩哔哩在进入p...
脚本解迷!德扑HHpoker有... 脚本解迷!德扑HHpoker有挂吗,hhpoker免费辅助器(透视)竟然是有攻略(哔哩哔哩)1)辅助...
透视透视挂!we poker游... 透视透视挂!we poker游戏下,微乐家乡小程序辅助,关于脚本(有人有挂)-哔哩哔哩we poke...
脚本曝光!wepoker透视底... 脚本曝光!wepoker透视底牌脚本,wejoker开挂(透视)都是真的是有插件(哔哩哔哩)1、玩家...
更值得关注的是!wepoker... 您好,wepoker透视脚本网页这款游戏可以开挂的,确实是有挂的,需要了解加去威信【48527505...
脚本有挂!wepoker破解是... 脚本有挂!wepoker破解是真的还是假的,wepoker破解器(透视)竟然是有器(哔哩哔哩)1、模...
透视有挂!pokemmo辅助脚... 透视有挂!pokemmo辅助脚本,微信小程序微乐房间的挂多少钱,详情透视(有挂辅助)-哔哩哔哩pok...
透视必备!wepoker透视底... 透视必备!wepoker透视底牌脚本,wepoker私人辅助器(透视)其实存在有器(哔哩哔哩)1、许...
今年以来!大菠萝免费辅助器,微... 今年以来!大菠萝免费辅助器,微信小程序微乐辅助器,科普脚本(有挂功能)-哔哩哔哩大菠萝免费辅助器透视...
透视安装!newpoker脚本... 透视安装!newpoker脚本,手机微乐小程序游戏破解器,分享透视(有挂猫腻)-哔哩哔哩newpok...