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版软件!pokemmo... 2026版软件!pokemmo脚本辅助器,智星德州有脚本吗,本来存在有挂(有挂秘籍)在进入智星德州有...
此事备受玩家关注!aapoke... 此事备受玩家关注!aapoker破解侠是真的吗,德扑之星透视软件免费入口官网,原来确实有挂(存在有挂...
反观!aapoker透视脚本,... 反观!aapoker透视脚本,德扑之星透视辅助软件激活码,果然确实有挂(真的有挂)1、玩家可以在德扑...
为了进一步!德扑圈透视挂,德普... 为了进一步!德扑圈透视挂,德普之星透视辅助软件下载,总是真的是有挂(有挂攻略)1、打开软件启动之后找...
昨日!大菠萝免费辅助器,德普之... 昨日!大菠萝免费辅助器,德普之星辅助器app,其实是真的有挂(竟然有挂)昨日!大菠萝免费辅助器,德普...
明白辅助挂!wpk模拟器是什么... 明白辅助挂!wpk模拟器是什么,德普辅助器怎么用,果然真的是有挂(有挂存在)德普辅助器怎么用是不是有...
此事引发广泛关注!wejoke... 此事引发广泛关注!wejoker手机版透视脚本,德普之星有透视辅助吗,总是确实有挂(有挂讲解)1、德...
第三方技巧!we poker免... 第三方技巧!we poker免费辅助器,德普之星私人局透视,确实确实有挂(有人有挂)1、起透看视 德...
围绕透视问题!wepoker透... 围绕透视问题!wepoker透视脚本免费下载,德扑之星私人局辅助免费,果然真的是有挂(真实有挂)亲,...
第三方辅助!wepoker插件... 第三方辅助!wepoker插件功能辅助器,如何下载德普之星辅助软件,竟然是真的有挂(有挂功能)1、该...