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:
    

相关内容

热门资讯

重大通报!wepoker辅助分... 重大通报!wepoker辅助分析器(辅助挂)原来是有挂(有挂秘诀)1、该软件可以轻松地帮助玩家将we...
三分钟了解!aapoker怎么... 三分钟了解!aapoker怎么拿好牌(辅助挂)其实是真的有挂(有挂攻略)在进入aapoker怎么拿好...
必备攻略!wejoker辅助脚... 必备攻略!wejoker辅助脚本(辅助挂)本来有挂(有挂规律)1、实时wejoker辅助脚本透视辅助...
今日重大通报!wpk模拟器(辅... 今日重大通报!wpk模拟器(辅助挂)切实是有挂(的确有挂)1、用户打开应用后不用登录就可以直接使用,...
必看攻略!pokemmo手机版... 必看攻略!pokemmo手机版脚本(辅助挂)原来是真的有挂(有挂详情)1、必看攻略!pokemmo手...
记者发布!wepoker私人局... 记者发布!wepoker私人局透视方法(辅助挂)真是有挂(讲解有挂)1、金币登录送、破产送、升级送、...
教程辅助!hhpoker德州有... 教程辅助!hhpoker德州有挂吗(辅助挂)其实是有挂(有挂方法)1、这是跨平台的hhpoker德州...
六分钟了解!德普之星辅助软件(... 六分钟了解!德普之星辅助软件(辅助挂)真是是有挂(有挂透视)1、进入游戏-大厅左侧-新手福利-激活码...
详细说明!aapoker辅助工... 详细说明!aapoker辅助工具安全吗(辅助挂)一贯真的有挂(有挂猫腻)aapoker辅助工具安全吗...
总算了解!aapoker插件(... 总算了解!aapoker插件(辅助挂)本来是真的有挂(有挂秘诀)1、下载好aapoker插件正确养号...