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:
    

相关内容

热门资讯

透视脚本!wepoker辅助器... 透视脚本!wepoker辅助器(透视)wepoker轻量版透视(都是一直总是有辅助器)-哔哩哔哩1、...
透视app!丽水都莱辅助软件(... 透视app!丽水都莱辅助软件(辅助)潮友辅助器开挂软件(一贯一直总是有挂)-哔哩哔哩1、在潮友辅助器...
透视技巧!德州局怎么透视(透视... 透视技巧!德州局怎么透视(透视)hhpoker免费透视脚本(其实是有脚本)-哔哩哔哩一、hhpoke...
透视技巧!wepoker辅助器... 透视技巧!wepoker辅助器软件下载(透视)wepoker高级辅助(切实是真的有挂)-哔哩哔哩1....
透视神器!wepoker透视脚... 您好,wepoker透视脚本苹果版这款游戏可以开挂的,确实是有挂的,需要了解加去威信【4852750...
透视工具!hhpoker作必弊... 透视工具!hhpoker作必弊码(透视)hhpoker怎么破解(本来是有挂)-哔哩哔哩一、hhpok...
透视技巧!wepoker数据分... 透视技巧!wepoker数据分析(透视)wepoker可以透视码(一直一直都是有透视)-哔哩哔哩1、...
透视方法!wepoker私人局... 透视方法!wepoker私人局俱乐部(透视)wepoker私人局有透视吗(本来一直都是有辅助器)-哔...
透视技巧!wepoker祈福有... 透视技巧!wepoker祈福有用吗(透视)wejoker免费脚本(果然一直都是有脚本)-哔哩哔哩1、...
透视app!wpk辅助购买(透... 透视app!wpk辅助购买(透视)wpk俱乐部是真的吗(都是存在有透视)-哔哩哔哩1、每一步都需要思...