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:
    

相关内容

热门资讯

透视ai!wepoker私人局... 透视ai!wepoker私人局开挂视频,sohoo poker辅助(透视)了解教程(有挂方法)-哔哩...
辅助透视!wepokerplu... 辅助透视!wepokerplus到底是挂了吗,werplan免费挂下载(透视)推荐教程(发现有挂)-...
截至目前!aapoker透视怎... 您好,aapoker透视怎么用这款游戏可以开挂的,确实是有挂的,需要了解加去威信【485275054...
透视好牌!aapoker公共底... 透视好牌!aapoker公共底牌,wepoker好友房开挂(透视)总结教程(有挂工具)-哔哩哔哩1、...
现有关情况通报如下!sohoo... 现有关情况通报如下!sohoopoker辅助,aapoker真的假的(透视)解密教程(有挂分享)-哔...
透视能赢!wepoker私人局... 透视能赢!wepoker私人局透视方法,wepoker私局辅助(透视)教你教程(有挂辅助)-哔哩哔哩...
透视存在!wpk模拟器多开,w... 透视存在!wpk模拟器多开,wepoker怎么增加运气(透视)解密教程(有挂讲解)-哔哩哔哩1、用户...
透视存在!sohoo竞技联盟辅... 透视存在!sohoo竞技联盟辅助器,德普之星有透视辅助吗(透视)推荐教程(有挂方略)-哔哩哔哩1、上...
透视规律!hhpoker开挂教... 透视规律!hhpoker开挂教程,wepoker辅助透视(透视)总结教程(有挂秘笈)-哔哩哔哩1、不...
透视新版!拱趴大菠萝机器人,n... 透视新版!拱趴大菠萝机器人,newpoker脚本(透视)开挂教程(有挂猫腻)-哔哩哔哩1、拱趴大菠萝...