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:
    

相关内容

热门资讯

第8分钟了解(德扑之星房间设置... 第8分钟了解(德扑之星房间设置)外挂智能ai辅助插件(透视)攻略教程(2024已更新)(哔哩哔哩);...
第3分钟了解(德州智能)软件透... 您好,德州智能这款游戏可以开挂的,确实是有挂的,需要了解加微【136704302】很多玩家在这款游戏...
三分钟了解(Wepoke检测)... 三分钟了解(Wepoke检测)外挂智能ai辅助安装(透视)透牌教程(2026已更新)(哔哩哔哩);三...
6分钟了解(德扑之星)外挂辅助... 6分钟了解(德扑之星)外挂辅助插件安装器(透视)玩家教你(2023已更新)(哔哩哔哩);是一款可以让...
第7分钟了解(AAPOKer)... 第7分钟了解(AAPOKer)软件透明挂辅助软件(透视)必备教程(2024已更新)(哔哩哔哩);AA...
四分钟了解(wepoke规律)... 四分钟了解(wepoke规律)外挂智能ai辅助挂(透视)线上教程(2025已更新)(哔哩哔哩);1、...
四分钟了解(aapoker猫腻... 四分钟了解(aapoker猫腻)外挂辅助插件安装代打(透视)技巧教程(2022已更新)(哔哩哔哩)是...
第六分钟了解(德扑之星带入)软... 【福星临门,好运相随】;第六分钟了解(德扑之星带入)软件透明挂辅助工具(透视)攻略教程(2025已更...
第9分钟了解(微扑克游戏)外挂... 第9分钟了解(微扑克游戏)外挂智能ai辅助科技(透视)微扑克教程(2023已更新)(哔哩哔哩);1、...
一分钟了解(德州手机)黑科技透... 一分钟了解(德州手机)黑科技透明挂辅助工具(透视)辅助教程(2024已更新)(哔哩哔哩);一、德州手...