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:
    

相关内容

热门资讯

六分钟开挂!微乐小程序免费黑科... 六分钟开挂!微乐小程序免费黑科技,微乐小程序辅助脚本靠谱的(开挂)其实是有挂(2026)1、微乐小程...
为切实保障!微乐小程序免费黑科... 为切实保障!微乐小程序免费黑科技,微乐家乡app下载(透视)一直真的有挂(哔哩哔哩)亲,关键说明,微...
8分钟透视!微乐小程序黑科技,... 8分钟透视!微乐小程序黑科技,微信微乐辅助器使用教程(开挂)其实真的有挂(2026)1、微乐小程序黑...
突发!微乐小程序免费黑科技,微... 突发!微乐小程序免费黑科技,微乐小程序辅助器免费(透视)都是存在有挂(哔哩哔哩)暗藏猫腻,小编详细说...
第2分钟神器!微乐小程序免费黑... 第2分钟神器!微乐小程序免费黑科技,微乐江苏小程序游戏破解下载(开挂)好像有挂(2026)1.微乐小...
透视安卓版!微乐小程序免费黑科... 透视安卓版!微乐小程序免费黑科技,微乐广西小程序插件(透视)总是真的是有挂(哔哩哔哩)1、操作简单,...
第3分钟神器!微乐小程序免费黑... 第3分钟神器!微乐小程序免费黑科技,微乐小程序脚本入口(开挂)一直真的是有挂(2026)微乐小程序免...
做出回应!微乐小程序免费黑科技... 做出回应!微乐小程序免费黑科技,微乐家乡辅助app免费(透视)总是有挂(哔哩哔哩)1、微乐小程序免费...
两分钟脚本!微乐小程序免费黑科... 两分钟脚本!微乐小程序免费黑科技,微乐小程序自建房辅助ios(开挂)竟然是有挂(2026)1)微乐小...
第二分钟下载!微乐小程序免费黑... 第二分钟下载!微乐小程序免费黑科技,广西微乐小程序微信辅助器免费(开挂)好像是有挂(2026)1、打...