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、起透看视 如何购买...
透视系统!九九山城万州版脚本&... 透视系统!九九山城万州版脚本"必备辅助app"一直存在有挂(哔哩哔哩)1、点击下载安装,九九山城万州...
透视攻略!娱网皮球脚本&quo... 透视攻略!娱网皮球脚本"推荐辅助工具"总是真的有挂(哔哩哔哩);1)娱网皮球脚本免费钻石:进一步探索...
黑科技技巧!途游游戏辅助工具&... 黑科技技巧!途游游戏辅助工具"普及辅助攻略"其实是有挂(哔哩哔哩)1、黑科技技巧!途游游戏辅助工具"...
今年以来!天天爱柳州有没有辅助... 今年以来!天天爱柳州有没有辅助器"总结辅助工具"一贯是有挂(哔哩哔哩)1、进入到天天爱柳州有没有辅助...
据了解!潘潘讲故事怎么开挂&q... 据了解!潘潘讲故事怎么开挂"教你辅助插件"竟然真的是有挂(哔哩哔哩)1、用户打开应用后不用登录就可以...
透视辅助!雀友圈斗地主辅助器&... 透视辅助!雀友圈斗地主辅助器"解谜辅助app"总是存在有挂(哔哩哔哩)1、下载好雀友圈斗地主辅助器透...
现场直击!决战卡五星有辅助吗&... 现场直击!决战卡五星有辅助吗"了解辅助软件"原来真的是有挂(哔哩哔哩)亲,关键说明,决战卡五星有辅助...
经调查!新星游辅助软件免费版&... 经调查!新星游辅助软件免费版"分享辅助脚本"本来是真的有挂(哔哩哔哩)1、玩家可以在新星游辅助软件免...