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:
    

相关内容

热门资讯

黑科技透视挂!微信小程序微乐陕... 黑科技透视挂!微信小程序微乐陕西挖坑辅助(透视挂),微乐福州麻将好像是有透视挂插件1)微信小程序微乐...
黑科技开挂!微信小程序微乐辅助... 黑科技开挂!微信小程序微乐辅助器教程(开挂),微乐陕西麻将果然真的是有透视挂方法微信小程序微乐辅助器...
黑科技作弊器!小程序微乐辅助器... 黑科技作弊器!小程序微乐辅助器2.0(作弊器),微乐明皇暗保真是真的是有透视挂软件1、操作简单,无需...
黑科技辅助器!小程序跑得快的技... 黑科技辅助器!小程序跑得快的技巧(辅助器),微乐麻将果然是真的有透视挂方法1、打开软件启动之后找到中...
黑科技开挂!微乐小程序自建房透... 黑科技开挂!微乐小程序自建房透视下载(开挂),微乐血流麻将总是有透视挂软件1、让任何用户在无需微乐小...
黑科技外挂!微信小程序游戏破解... 黑科技外挂!微信小程序游戏破解微乐游戏(外挂),微乐邵阳麻将好像存在有透视挂脚本1、玩家可以在微信小...
黑科技外挂!微信小程序微乐辅助... 黑科技外挂!微信小程序微乐辅助器破解版(外挂),微乐明皇暗保果然存在有透视挂方法1、微信小程序微乐辅...
黑科技透视器!微乐家乡脚本助手... 黑科技透视器!微乐家乡脚本助手(透视器),微乐宁夏捉老麻子果然真的是有透视挂技巧1、点击下载安装,微...
黑科技辅助!微乐自建房透视(辅... 黑科技辅助!微乐自建房透视(辅助),微乐陕西挖坑本来真的有透视挂攻略运微乐自建房透视辅助工具,进入游...
黑科技透视挂!微乐自建房脚本免... 黑科技透视挂!微乐自建房脚本免费下载入口(透视挂),微乐唐山麻将真是存在有透视挂工具1、上手简单,内...