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、超多福利:超高返利,海量正...
重大通报透视挂方法!三鑫联盟多... 重大通报透视挂方法!三鑫联盟多功能透视挂方法,三鑫联盟一贯真的有透视挂方法1、操作简单,无需三鑫联盟...
玩家必看教程辅助器技巧!掌上约... 玩家必看教程辅助器技巧!掌上约牌多功能辅助器技巧,掌上约牌都是真的有辅助器技巧1)掌上约牌辅助插件:...
重大通报外挂方法!中至山西麻将... 重大通报外挂方法!中至山西麻将多功能外挂方法,中至山西麻将本来存在有外挂方法1、中至山西麻将免费脚本...
重要通知透视挂app!丹东约战... 重要通知透视挂app!丹东约战麻将多功能透视挂app,丹东约战麻将好像真的有透视挂app1、丹东约战...
今日公布外挂插件!亲邻麻将多功... 今日公布外挂插件!亲邻麻将多功能外挂插件,亲邻麻将原来是真的有外挂插件1、该软件可以轻松地帮助玩家将...