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:
    

相关内容

热门资讯

揭秘关于!手机透视辅助器app... 揭秘关于!手机透视辅助器app(辅助挂)wpk模拟器多开(其实有挂)是一款可以让一直输的玩家,快速成...
重大通报!微乐自建房辅助(辅助... 重大通报!微乐自建房辅助(辅助挂)xpoker辅助工具(最初真的有挂);微乐自建房辅助软件透明挂是一...
每日必备!内蒙博乐填大坑辅助(... 您好:内蒙博乐填大坑辅助这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的...
总算了解!新道游游戏辅助器安装... 总算了解!新道游游戏辅助器安装包(辅助挂)德普之星透视辅助软件下载(确实是真的有挂);新道游游戏辅助...
记者爆料!打哈儿床将作弊(辅助... 记者爆料!打哈儿床将作弊(辅助挂)德扑之心免费透视(从前是真的有挂);1、许多玩家不知道打哈儿床将作...
分享实测!情怀游戏辅助器破解版... 分享实测!情怀游戏辅助器破解版(辅助挂)hhpoker可以控制吗(其实是有挂);情怀游戏辅助器破解版...
一分钟了解!微乐辅助脚本(辅助... 一分钟了解!微乐辅助脚本(辅助挂)wpk透视是真的假的(一直有挂);1.微乐辅助脚本 ai辅助创建新...
一分钟了解!火神辅助免费下载(... 一分钟了解!火神辅助免费下载(辅助挂)wepoker辅助软件价格(往昔真的有挂)是一款可以让一直输的...
必备科技!天蝎辅助(辅助挂)德... 必备科技!天蝎辅助(辅助挂)德扑HHpoker有挂吗(确实是真的有挂);天蝎辅助辅助器中分为三种模型...