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透视有吗,拱趴大菠萝辅助神器,绝活教程(有挂方法)1、这是跨平台的拱趴大菠...
第7分钟辅助!wepoker高... 第7分钟辅助!wepoker高级辅助,wepoker免费脚本咨询,窍门教程(有挂方法)wepoker...
一分钟辅助!德普之星怎么开辅助... 一分钟辅助!德普之星怎么开辅助,拱趴大菠萝挂,资料教程(有挂方略)1、德普之星怎么开辅助破解器简单,...
一分钟辅助!约局吧作弊脚本,h... 一分钟辅助!约局吧作弊脚本,hhpkoer辅助器,秘籍教程(真的有挂)1、让任何用户在无需约局吧作弊...
第五分钟辅助!德州透视插件,w... 第五分钟辅助!德州透视插件,wepoker私人局外卦,经验教程(有挂方法)1、下载好wepoker私...
九分钟辅助!aapoker辅助... 九分钟辅助!aapoker辅助软件合法吗,拱趴大菠萝挂哪里,指引教程(有挂头条)1、全新机制【aap...
六分钟辅助!wepoker免费... 六分钟辅助!wepoker免费透视脚本,wepoker安装教程,指南书教程(有挂分析)1、wepok...
3分钟辅助!wepoker私局... 3分钟辅助!wepoker私局代打,xpoker透视辅助,指南教程(有挂透明挂)1、wepoker私...
第九分钟辅助!pokemmo脚... 第九分钟辅助!pokemmo脚本辅助下载,wepoker透视器免费,资料教程(有挂教程)进入游戏-大...
第1分钟辅助!wpk透视辅助靠... 您好,wpk透视辅助靠谱吗这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很...