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:
    

相关内容

热门资讯

重大通报透视器!娱家麻将透视器... 重大通报透视器!娱家麻将透视器AI脚本,娱家麻将多功能切实真的是有透视器脚本1、娱家麻将辅助软件下载...
重大消息开挂!家乡大贰开挂AI... 重大消息开挂!家乡大贰开挂AI插件,家乡大贰多功能果然有开挂插件家乡大贰脚本下载中分为三种模型:家乡...
玩家必看科普外挂!河洛杠次外挂... 玩家必看科普外挂!河洛杠次外挂AI工具,河洛杠次多功能一直是真的有外挂工具亲,关键说明,河洛杠次透视...
重大来袭开挂!广西老友玩开挂A... 重大来袭开挂!广西老友玩开挂AIapp,广西老友玩多功能竟然有开挂app1、每一步都需要思考,不同水...
科技揭秘透视挂!嘟咪互动麻将透... 科技揭秘透视挂!嘟咪互动麻将透视挂AI插件,嘟咪互动麻将多功能竟然是有透视挂插件1、玩家可以在嘟咪互...
盘点几款辅助器!微乐河北麻将辅... 盘点几款辅助器!微乐河北麻将辅助器AI工具,微乐河北麻将多功能竟然存在有辅助器工具盘点几款辅助器!微...
盘点一款透视挂!星际互联透视挂... 盘点一款透视挂!星际互联透视挂AI方法,星际互联多功能竟然是有透视挂方法1、星际互联破解器简单,星际...
推荐十款开挂!MG棋牌开挂AI... 推荐十款开挂!MG棋牌开挂AI教程,MG棋牌多功能一直是真的有开挂教程1、每一步都需要思考,不同水平...
记者揭秘辅助器!大圣天辅助器A... 记者揭秘辅助器!大圣天辅助器AI教程,大圣天多功能切实真的有辅助器教程1)大圣天免费钻石:进一步探索...
技术分享作弊器!赣牌圈打炸作弊... 技术分享作弊器!赣牌圈打炸作弊器AI插件,赣牌圈打炸多功能确实是有作弊器插件1、起透看视 赣牌圈打炸...