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:
    

相关内容

热门资讯

第三分钟辅助!微乐小程序辅助器... 第三分钟辅助!微乐小程序辅助器出租,微乐小程序免费黑科技,教材教程(有挂安装)-哔哩哔哩一、微乐小程...
第3分钟脚本!微乐广西小程序,... 第3分钟脚本!微乐广西小程序,微乐小程序免费黑科技,项目教程(有挂辅助)-哔哩哔哩微乐小程序免费黑科...
八分钟安装!微信微乐小程序辅助... 八分钟安装!微信微乐小程序辅助软件,微乐小程序免费黑科技,技法教程(有挂app)-哔哩哔哩微信微乐小...
第九分钟安装!微乐小游戏万能修... 第九分钟安装!微乐小游戏万能修改器,微乐小程序免费黑科技,举措教程(有挂工具)-哔哩哔哩1、微乐小游...
六分钟辅助!小程序微乐辅助器i... 六分钟辅助!小程序微乐辅助器ios,微乐小程序黑科技,举措教程(有挂修改器)-哔哩哔哩小程序微乐辅助...
第7分钟插件!微信小程序微乐辅... 第7分钟插件!微信小程序微乐辅助器贴吧,微乐小程序黑科技,法子教程(有挂脚本)-哔哩哔哩1、游戏颠覆...
9分钟脚本!微信小程序微乐挂如... 9分钟脚本!微信小程序微乐挂如何获取,微乐小程序黑科技,指南书教程(有挂软件)-哔哩哔哩1、9分钟脚...
第九分钟脚本!如何下载微乐自建... 第九分钟脚本!如何下载微乐自建房黑科技入口,微乐小程序免费黑科技,妙招教程(有挂平台)-哔哩哔哩1、...
七分钟脚本!微信小程序微乐辅助... 七分钟脚本!微信小程序微乐辅助,微乐小程序免费黑科技,窍门教程(有挂软件)-哔哩哔哩小薇(辅助器软件...
第3分钟辅助!微乐小程序破解,... 第3分钟辅助!微乐小程序破解,微乐小程序免费黑科技,模块教程(有挂神器)-哔哩哔哩所有人都在同一条线...