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:
    

相关内容

热门资讯

透视好友!wejoker辅助脚... 透视好友!wejoker辅助脚本,we poker辅助器v3.3,手段教程(都是是真的挂)-哔哩哔哩...
透视后台!hhpoker是真的... 透视后台!hhpoker是真的还是假的(透视)开挂辅助技巧(一直真的是有挂)-哔哩哔哩1、游戏颠覆性...
透视真的!wpk德州局怎么透视... 透视真的!wpk德州局怎么透视,智星菠萝可以辅助吗,诀窍教程(本来是真的挂)-哔哩哔哩1、这是跨平台...
透视代打!hhpoker破解工... 透视代打!hhpoker破解工具(透视)开挂辅助神器(切实存在有挂)-哔哩哔哩1、全新机制【hhpo...
透视好牌!菠萝辅助器免费版的特... 透视好牌!菠萝辅助器免费版的特点,hhpoker透视脚本,教程书教程(都是是有挂)-哔哩哔哩1、每一...
透视开挂!hhpoker有没有... 透视开挂!hhpoker有没有辅助挂(透视)开挂辅助插件(确实真的有挂)-哔哩哔哩在进入hhpoke...
透视软件!wpk辅助购买,we... 您好,wepoker是不是有人用挂这款游戏可以开挂的,确实是有挂的,需要了解加去威信【1367043...
透视教程!wpk官网下载链接(... 透视教程!wpk官网下载链接(透视)开挂辅助挂(一直是有挂)-哔哩哔哩;1、透视教程!wpk官网下载...
透视透视!模拟器打开hhpok... 透视透视!模拟器打开hhpoker,哈糖大菠萝辅助器,手册教程(本来有挂)-哔哩哔哩1、超多福利:超...
透视德州版!hardrock辅... 透视德州版!hardrock辅助(透视)开挂辅助插件(确实有挂)-哔哩哔哩1)hardrock辅助辅...