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:
    

相关内容

热门资讯

规律辅助挂!微信牵手跑辅助&q... 规律辅助挂!微信牵手跑辅助"切实存在有辅助技巧"(哔哩哔哩)1、完成微信牵手跑辅助辅助器v3.3的残...
据权威媒体报道!菠萝德州透视脚... 据权威媒体报道!菠萝德州透视脚本"原来确实有辅助挂"(哔哩哔哩)1、菠萝德州透视脚本破解器简单,菠萝...
围绕透视问题!凑一桌开挂游戏辅... 围绕透视问题!凑一桌开挂游戏辅助"果然真的是有辅助挂"(哔哩哔哩)1、下载好凑一桌开挂游戏辅助脚本下...
连日来!逍遥湖北微信辅助&qu... 连日来!逍遥湖北微信辅助"竟然是有辅助挂"(哔哩哔哩)1、逍遥湖北微信辅助免费脚本咨询教程、逍遥湖北...
随着!微信小程序家乡大贰辅助器... 随着!微信小程序家乡大贰辅助器"其实真的是有辅助软件"(哔哩哔哩)1、任何微信小程序家乡大贰辅助器透...
值得注意的是!九九联盟后台可以... 值得注意的是!九九联盟后台可以操作吗"好像真的有辅助插件"(哔哩哔哩)1)九九联盟后台可以操作吗有没...
据悉!衢州都莱罗松怎么老是输&... 据悉!衢州都莱罗松怎么老是输"竟然真的有辅助挂"(哔哩哔哩)所有人都在同一条线上,像星星一样排成一排...
长期以来!白金岛放炮罚开挂&q... 长期以来!白金岛放炮罚开挂"一直存在有辅助神器"(哔哩哔哩)1、超多福利:超高返利,海量正版游戏,白...
复盘辅助挂!正宗牛总管辅助&q... 复盘辅助挂!正宗牛总管辅助"确实确实有辅助神器"(哔哩哔哩)暗藏猫腻,小编详细说明正宗牛总管辅助破解...
不少玩家反映!蜀山四川小程序辅... 不少玩家反映!蜀山四川小程序辅助开挂"原来是真的有辅助教程"(哔哩哔哩)一、蜀山四川小程序辅助开挂可...