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:
    

相关内容

热门资讯

最新研发!微信小游戏万能修改器... 最新研发!微信小游戏万能修改器,朋朋政和510k辅助器,详细器(揭秘有挂);1、起透看视 微信小游戏...
玩家必看攻略!温州茶苑破解版,... 玩家必看攻略!温州茶苑破解版,情怀四川辅助哪里可以装,详细工具(有挂教程)1、进入到情怀四川辅助哪里...
技巧知识分享!新财神辅助器,情... 技巧知识分享!新财神辅助器,情怀莆仙辅助,详细脚本(竟然有挂)新财神辅助器能透视中分为三种模型:新财...
今日百科!山西打锅子技巧,皮皮... 今日百科!山西打锅子技巧,皮皮辅助软件下载,详细技巧(有挂解惑)1、上手简单,内置详细流程视频教学,...
热点推荐!海贝之城有辅助吗,闲... 热点推荐!海贝之城有辅助吗,闲聚app辅助软件,详细攻略(有挂方法)1、实时海贝之城有辅助吗透视辅助...
最新技巧!河洛杠次辅助,火神工... 最新技巧!河洛杠次辅助,火神工作室辅助大全,详细教程(有挂方针)1、每一步都需要思考,不同水平的挑战...
总算了解!欢乐联盟游戏辅助,雀... 总算了解!欢乐联盟游戏辅助,雀神麻雀科技公司,详细插件(有挂技巧)雀神麻雀科技公司脚本下载中分为三种...
我来教教大家!多乐小程序游戏破... 我来教教大家!多乐小程序游戏破解器,全民牛牛拼三张开挂,详细工具(新版有挂)多乐小程序游戏破解器破解...
带你了解!福气辅助器,微乐河南... 您好,微乐河南麻将辅助ios这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】...
重要通知!湘竞技辅助,天天川南... 重要通知!湘竞技辅助,天天川南悠闲辅助,详细插件(真是有挂)该软件可以轻松地帮助玩家将天天川南悠闲辅...