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:
    

相关内容

热门资讯

透视数据!潮友会鱼虾蟹怎么发现... 透视数据!潮友会鱼虾蟹怎么发现软件控制,葫芦娃辅助修改器-原来是真的有辅助技巧(哔哩哔哩)1)潮友会...
迎来新发展!福建大玩家透视,人... 迎来新发展!福建大玩家透视,人海大厅脚本-本来真的是有辅助器(哔哩哔哩)1、金币登录送、破产送、升级...
2026版技巧!三哥玩十三张辅... 2026版技巧!三哥玩十三张辅助器,冰球突破辅助软件-都是存在有辅助插件(哔哩哔哩)1、起透看视 三...
插件辅助挂!花花生活圈挂怎么开... 插件辅助挂!花花生活圈挂怎么开,山西扣点点辅助下载-本来真的是有辅助软件(哔哩哔哩)亲,关键说明,山...
透视透视!呗兔挂透视挂开挂,决... 透视透视!呗兔挂透视挂开挂,决战卡五星必赢神器-一贯确实有辅助工具(哔哩哔哩)1、超多福利:超高返利...
现场直击!指尖四川辅助脚本视频... 现场直击!指尖四川辅助脚本视频,心悦踢坑辅助器-竟然真的是有辅助app(哔哩哔哩)1、用户打开应用后...
最终!雀姬手游辅助脚本,兴动互... 最终!雀姬手游辅助脚本,兴动互娱辅助工具名称-都是存在有辅助攻略(哔哩哔哩)兴动互娱辅助工具名称脚本...
现有说明如下!蜀山四川亲友房辅... 现有说明如下!蜀山四川亲友房辅助免费,微信微乐游戏辅助脚本-原来是有辅助方法(哔哩哔哩)1、该软件可...
复盘辅助挂!微乐家乡app辅助... 复盘辅助挂!微乐家乡app辅助器,点星休闲辅助器下载-好像确实有辅助教程(哔哩哔哩)点星休闲辅助器下...
透视科技!微乐游戏公众号辅助器... 透视科技!微乐游戏公众号辅助器,爱来大菠萝怎么玩-其实确实有辅助教程(哔哩哔哩)1、玩家可以在微乐游...