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:
    

相关内容

热门资讯

2分钟分享!闲逸辅助插件,瓜瓜... 2分钟分享!闲逸辅助插件,瓜瓜丰城双剑旧版攻略(其实真的有挂)-哔哩哔哩1、瓜瓜丰城双剑旧版攻略透视...
第二分钟详情!友友联盟辅助软件... 第二分钟详情!友友联盟辅助软件下载,新漫游免费辅助器(其实是真的挂)-哔哩哔哩1、友友联盟辅助软件下...
第六分钟详情!崇阳斗棋辅助脚本... 第六分钟详情!崇阳斗棋辅助脚本视频,花花生活圈脚本(切实有挂)-哔哩哔哩1、崇阳斗棋辅助脚本视频透视...
9分钟曝光!对战互娱有辅助吗,... 9分钟曝光!对战互娱有辅助吗,广西老友玩插件(一直有挂)-哔哩哔哩1、进入到对战互娱有辅助吗黑科技之...
第六分钟必备!先锋大厅辅助,皮... 第六分钟必备!先锋大厅辅助,皮皮跑子胡子修改器(真是存在有挂)-哔哩哔哩1、每一步都需要思考,不同水...
第八分钟揭幕!多乐够级脚本,兴... 第八分钟揭幕!多乐够级脚本,兴动休闲辅助(其实是有挂)-哔哩哔哩1、进入到兴动休闲辅助黑科技之后,能...
第七分钟解迷!腾威互娱破解辅助... 第七分钟解迷!腾威互娱破解辅助工具,起点休闲辅助(切实是真的挂)-哔哩哔哩1、完成腾威互娱破解辅助工...
六分钟揭幕!新星游挂多少钱,新... 六分钟揭幕!新星游挂多少钱,新珊瑚大厅辅助(都是是真的挂)-哔哩哔哩1、新星游挂多少钱ai机器人多个...
7分钟详情!心悦游戏万能透视辅... 7分钟详情!心悦游戏万能透视辅助器免费,四川途游破解安装包(切实有挂)-哔哩哔哩1、心悦游戏万能透视...
七分钟详细!哈局十三张通用辅助... 七分钟详细!哈局十三张通用辅助,三哥玩辅助器(原来是有挂)-哔哩哔哩1、哈局十三张通用辅助系统规律教...