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、上手简单,内置详细流程视频教学...
玩家必看教程!熊猫四川麻将3D... 玩家必看教程!熊猫四川麻将3D版辅助器脚本软件,熊猫四川麻将3D版切实是有辅助器有挂攻略1、操作简单...
一起来探讨!萍乡情怀麻将辅助脚... 一起来探讨!萍乡情怀麻将辅助脚本软件,萍乡情怀麻将果然是有辅助推荐技巧1)萍乡情怀麻将免费钻石:进一...
新手必备!钱柜手游辅助器脚本软... 新手必备!钱柜手游辅助器脚本软件,钱柜手游都是有辅助器分享技巧1、钱柜手游脚本辅助下载、钱柜手游免费...
总算了解!腾龙透视挂脚本软件,... 总算了解!腾龙透视挂脚本软件,腾龙竟然有透视挂科普软件腾龙脚本下载中分为三种模型:腾龙挂靠谱的,腾龙...
玩家必备科技!微乐贵州麻将开挂... 玩家必备科技!微乐贵州麻将开挂脚本软件,微乐贵州麻将一直存在有开挂解密工具1、实时微乐贵州麻将透视辅...
科普常识!中至九江麻将辅助脚本... 科普常识!中至九江麻将辅助脚本软件,中至九江麻将一贯真的是有辅助解迷脚本1、在中至九江麻将插件功能辅...
盘点一款!情怀信阳开挂脚本软件... 盘点一款!情怀信阳开挂脚本软件,情怀信阳切实存在有开挂总结app1、情怀信阳辅助器安装包、情怀信阳辅...
最新研发!乐棋海南麻将辅助脚本... 最新研发!乐棋海南麻将辅助脚本软件,乐棋海南麻将都是真的是有辅助解密方法1、乐棋海南麻将免费辅助多个...
一分钟快速了解!苏州麻将透视脚... 一分钟快速了解!苏州麻将透视脚本软件,苏州麻将一直是真的有透视总结技巧1、很好的工具软件,可以解锁游...