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:
    

相关内容

热门资讯

一分钟了解!wepoker辅助... 您好,这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很多玩家在这款游戏中打...
玩家必看分享!wepoker透... 玩家必看分享!wepoker透视挂底牌(辅助挂)果然是真的有挂(真的有挂辅助app)1、在插件功能辅...
安装程序教程!wepoker私... 安装程序教程!wepoker私人局辅助挂(辅助挂)确实有挂(有挂辅助辅助教程)1、让任何用户在无需安...
玩家爆料!拱趴大菠萝万能辅助器... 玩家爆料!拱趴大菠萝万能辅助器(辅助挂)本来是有挂(有挂规律辅助攻略)1、很好的工具软件,可以解锁游...
今日头条!wepokerplu... 今日头条!wepokerplus外挂(辅助挂)确实有挂(有挂技巧辅助脚本)1、完成辅助器v3.3的残...
记者发布!fishpoker透... 记者发布!fishpoker透视底牌(辅助挂)切实是真的有挂(有挂方法辅助教程)1. 选牌创建新账号...
查到实测!aapoker脚本怎... 查到实测!aapoker脚本怎么用(辅助挂)果然是有挂(揭秘有挂辅助技巧)1. 选牌创建新账号,点击...
传递经验!wepoker轻量版... 传递经验!wepoker轻量版透视系统(辅助挂)其实存在有挂(有挂功能辅助软件)1、下载好正确养号方...
查到实测!红龙poker辅助器... 查到实测!红龙poker辅助器免费观看(辅助挂)都是是有挂(确实有挂辅助攻略)1、下载好脚本下载之后...
重大消息!wepoker怎么设... 重大消息!wepoker怎么设置房间(辅助挂)都是存在有挂(有挂秘笈辅助教程)1、不需要AI权限,帮...