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:
    

相关内容

热门资讯

盘点透视"WePok... 盘点透视"WePoker脚本实战效果"开挂(透视)辅助软件(终于懂了我来教教你)盘点透视"WePok...
资料透视!htx矩阵wepok... 资料透视!htx矩阵wepoker辅助,wepoker模拟器哪个好用,可靠技巧(有挂总结)-哔哩哔哩...
曝光透视"WePok... 曝光透视"WePoker德州开挂神器透视"开挂(透视)辅助平台(推荐一款细节方法)曝光透视"WePo...
技法透视!约局吧德州透视,we... 较多好评“微乐万能挂官网”开挂(透视)辅助教程 了解更多开挂安装加(136704302)微信号是一款...
发现透视"wepok... 发现透视"wepoker能不能透视辅助"开挂(透视)辅助神器(一分钟了解我来教教你)发现透视"wep...
练习透视!wepoker国外版... 您好:这款wepoker国外版透视游戏是可以开挂的,确实是有挂的,很多玩家在这款wepoker国外版...
策略透视!wepoker有透视... 策略透视!wepoker有透视功能吗,pokemmo脚本辅助,黑科技教程(有挂透视)-哔哩哔哩;无需...
课程透视!德州局怎么透视,po... 课程透视!德州局怎么透视,pokemmo免费脚本,总结教程(有挂教程)-哔哩哔哩1、下载安装好德州局...
操作透视!hhpoker免费透... hhpoker免费透视脚本是一款专注玩家量身打造的游戏记牌类型软件,在hhpoker免费透视脚本这款...
资料透视!werplan免费挂... 您好:werplan免费挂下载这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多...