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:
    

相关内容

热门资讯

揭秘几款!好运同桌透视脚本软件... 揭秘几款!好运同桌透视脚本软件,好运同桌一贯真的是有透视普及方法该软件可以轻松地帮助玩家将好运同桌外...
实测交流!嘻嘻红中麻将开挂脚本... 实测交流!嘻嘻红中麻将开挂脚本软件,嘻嘻红中麻将确实真的是有开挂科普攻略进入游戏-大厅左侧-新手福利...
2024教程!浙乐大厅辅助器脚... 2024教程!浙乐大厅辅助器脚本软件,浙乐大厅真是是真的有辅助器普及插件1、实时浙乐大厅透视辅助更新...
玩家必看分享!微浪开挂脚本软件... 玩家必看分享!微浪开挂脚本软件,微浪总是是有开挂解迷技巧1、实时微浪透视辅助更新:用户可以随时随地访...
一分钟教你!常来游戏透视挂脚本... 一分钟教你!常来游戏透视挂脚本软件,常来游戏果然是有透视挂曝光方法1、实时常来游戏透视辅助更新:用户...
一分钟揭秘!52麻将开挂脚本软... 一分钟揭秘!52麻将开挂脚本软件,52麻将真是有开挂教你脚本1.52麻将 选牌创建新账号,点击进入游...
终于知道!天天赢棋牌辅助脚本软... 终于知道!天天赢棋牌辅助脚本软件,天天赢棋牌果然真的是有辅助解谜app1、很好的工具软件,可以解锁游...
热门推荐!趣游中心开挂脚本软件... 热门推荐!趣游中心开挂脚本软件,趣游中心总是是真的有开挂普及教程亲,关键说明,趣游中心透视脚本安卓赛...
揭秘关于!繁花透视挂脚本软件,... 揭秘关于!繁花透视挂脚本软件,繁花其实是真的有透视挂有挂方法繁花能透视中分为三种模型:繁花模拟器、繁...
一分钟了解!四季湖南麻将透视脚... 一分钟了解!四季湖南麻将透视脚本软件,四季湖南麻将好像是有透视解密脚本一分钟了解!四季湖南麻将透视脚...