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:
    

相关内容

热门资讯

实操分享辅助挂!we-poke... 本地部署 AI 黑科技工具迎来新版本,不用上传文件到云端就能完成we-poker辅助解析、 AI 处...
热门推荐透视!we poker... 一款 AI 游戏攻略黑科技工具上线,查攻略效率直接开挂。它整合版本更新、装备搭配、BOSS 打法、牌...
玩家交流透视挂!wpk透视是真... AI 黑科技赛道又上新,这款智能处理工具堪称效率开挂,专门面向短视频创作者打造。它打通脚本撰写、AI...
AI教程辅助!wepoker有... AI教程辅助!wepoker有透视底牌吗,微扑克开挂技巧插件(往昔是真的有辅助)主打本地运行的 AI...
最新技巧!辅助挂!WPK购买,... 最新技巧!辅助挂!WPK购买,WPK可以开挂吗安装(确实真的是有辅助挂)AI 是一款可以让一直输的玩...
今日焦点透视挂!wpk德州局怎... 一款 AI 游戏攻略黑科技工具上线,查攻略效率直接开挂。它整合版本更新、装备搭配、BOSS 打法、牌...
2分钟细说透视挂!wepoke... 您好,2分钟细说透视挂!wepoker底牌透视,德扑之星怎么开挂工具(素来真的是有透视挂)这款游戏可...
玩家必备教程透视挂!WPK工具... 玩家必备教程透视挂!WPK工具,WPK可以装挂吗插件(从来有透视挂)主打本地运行的 AI 黑科技工具...
热点推荐辅助!wejoker辅... wejoker辅助软件AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略数...
盘点一款辅助器!微扑克游戏辅助... 微扑克游戏辅助器AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻略数据包,...