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、梦黄麻将免费脚本咨询教...
研究成果辅助器教程!小白大作战... 研究成果辅助器教程!小白大作战多功能辅助器教程,小白大作战确实真的有辅助器教程所有人都在同一条线上,...
分享认知辅助软件!小闲巴渝棋牌... 分享认知辅助软件!小闲巴渝棋牌多功能辅助软件,小闲巴渝棋牌竟然是有辅助软件1、不需要AI权限,帮助你...
分享认知透视器app!温岭逸趣... 分享认知透视器app!温岭逸趣麻将多功能透视器app,温岭逸趣麻将真是是有透视器app1)温岭逸趣麻...
专业讨论作弊器插件!欢乐划水麻... 专业讨论作弊器插件!欢乐划水麻将多功能作弊器插件,欢乐划水麻将果然真的是有作弊器插件1、用户打开应用...
最新技巧外挂攻略!逍遥皖北棋牌... 最新技巧外挂攻略!逍遥皖北棋牌多功能外挂攻略,逍遥皖北棋牌都是存在有外挂攻略亲,关键说明,逍遥皖北棋...
今日公布辅助app!乐通多功能... 今日公布辅助app!乐通多功能辅助app,乐通一直有辅助app1、乐通破解器简单,乐通机器人操作,乐...
揭秘一下辅助攻略!青橙竞技多功... 揭秘一下辅助攻略!青橙竞技多功能辅助攻略,青橙竞技一贯真的是有辅助攻略1、玩家可以在青橙竞技线上大神...
推荐一款透视挂技巧!无锡麻将多... 推荐一款透视挂技巧!无锡麻将多功能透视挂技巧,无锡麻将原来有透视挂技巧1、起透看视 无锡麻将辅助软件...