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:
    

相关内容

热门资讯

五分钟透明!博乐温州棋牌有没有... 这是一款非常优秀的博乐温州棋牌有没有挂 ia辅助检测软件,能够让你了解到博乐温州棋牌有没有挂中牌率当...
六分钟辅助挂!博雅红河棋盘外挂... 1、六分钟辅助挂!博雅红河棋盘外挂,微扑克智能助手(详细透视辅助挂教程);详细教程。2、博雅红河棋盘...
6分钟黑科技!友友邳州麻将辅助... 6分钟黑科技!友友邳州麻将辅助器,微扑克靠谱(详细透视辅助软件教程);实战中需综合运用上述技巧,并根...
4分钟攻略!传送屋有外 挂,德... 4分钟攻略!传送屋有外 挂,德扑之星记分牌有有用(详细透视辅助挂教程);传送屋有外 挂黑科技是一款具...
5分钟了解!浙江游戏大厅辅具器... 5分钟了解!浙江游戏大厅辅具器,来玩app辅助工具(详细透视辅助器教程);(需添加指定薇757446...
7分钟介绍!广东雀神辅助器怎么... 7分钟介绍!广东雀神辅助器怎么买,微扑克职业代打(详细透视辅助助手教程);亲,其实确实真的有挂(需添...
三分钟攻略!可乐斗地主有没有挂... 三分钟攻略!可乐斗地主有没有挂,智星德州菠萝在哪下载(详细透视辅助神器教程);可乐斗地主有没有挂黑科...
九分钟规律!花花生活圈脚本,云... 九分钟规律!花花生活圈脚本,云扑克有辅助软件(详细透视辅助软件教程);(需添加指定薇75744690...
七分钟总结!中至窝龙必赢攻略,... 相信很多朋友都在电脑上玩过中至窝龙必赢攻略吧,但是很多朋友都在抱怨用电脑玩起来不方便。为此小编给大家...
1分钟详情!六瓣数字消有没有挂... 1分钟详情!六瓣数字消有没有挂,cloudpoker辅助器(详细透视辅助工具教程)关于六瓣数字消有没...