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:
    

相关内容

热门资讯

微扑克全自动机器人!微扑克辅助... 微扑克全自动机器人!微扑克辅助真的,微扑克wpk真的有辅助,黑科技教程(有挂脚本)1、让任何用户在无...
wepower有外 挂!wop... wepower有外 挂!wopoker手机辅助,wepoke能赢嘛,教你攻略(有挂黑科技);支持多人...
程序员教你!广西山水手机麻将有... 程序员教你!广西山水手机麻将有挂吗(透明挂)竟然是有挂(2020已更新)(哔哩哔哩);1、广西山水手...
5分钟辅助!人皇大厅牛牛怎么辅... 5分钟辅助!人皇大厅牛牛怎么辅助,wePOke一贯是真的有挂,可靠教程(有挂工具)一、人皇大厅牛牛怎...
微扑克有辅助挂!微扑克ai辅助... 一、微扑克简介了解软件请加微:136704302微扑克是一款在线扑克游戏平台,玩家可以在平台上进行多...
研究成果!闲玩暗宝外挂(辅助)... 研究成果!闲玩暗宝外挂(辅助)原来是有挂(2024已更新)(哔哩哔哩)该软件可以轻松地帮助玩家将闲玩...
wepoke透明挂黑科技!we... wepoke透明挂黑科技!wepokeapp下载教程(透视辅助)wepOkE(一直真的有挂);(需添...
7分钟科普!拱趴游戏有辅助器吗... 您好,拱趴游戏有辅助器吗这款游戏可以开挂的,确实是有挂的,需要了解加微【757446909】很多玩家...
微扑克系统发牌规律!微扑克算正... 微扑克系统发牌规律!微扑克算正规平台,WPK其实真的有挂,必备教程(有挂ai代打)1、任何德州ai辅...
分享开挂内幕!六瓣数字消有没有... 分享开挂内幕!六瓣数字消有没有挂(透视)切实真的有挂(2024已更新)(哔哩哔哩);1、进入游戏-大...