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、对战互娱免费辅助多个强度级别选择2、对战...
揭秘!大热门辅助功能工具,大热... 揭秘!大热门辅助功能工具,大热门本来真的有辅助工具1、揭秘!大热门辅助功能工具,大热门本来真的有辅助...
分享开挂内幕!九九联盟透视功能... 分享开挂内幕!九九联盟透视功能软件,九九联盟总是真的有透视软件1、下载好九九联盟透视辅助下载之后点击...
查到实测!澳门太阳城透视功能插... 查到实测!澳门太阳城透视功能插件,澳门太阳城好像存在有透视插件1、澳门太阳城辅助器安装包、澳门太阳城...
揭秘真相!江汉游戏透视挂功能教... 揭秘真相!江汉游戏透视挂功能教程,江汉游戏好像存在有透视挂教程1、江汉游戏辅助器安装包、江汉游戏辅助...