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:
    

相关内容

热门资讯

记者爆料作弊器!火鸟大厅作弊器... 记者爆料作弊器!火鸟大厅作弊器多功能AI方法,火鸟大厅切实真的是有作弊器方法运火鸟大厅辅助工具,进入...
盘点一款开挂!新世纪开挂多功能... 盘点一款开挂!新世纪开挂多功能AI脚本,新世纪好像是有开挂脚本小薇(辅助器软件下载)致您一封信;亲爱...
今日公布透视器!年年大厅透视器... 今日公布透视器!年年大厅透视器多功能AI插件,年年大厅切实是真的有透视器插件1、每一步都需要思考,不...
一分钟揭秘辅助器!火鸟大厅辅助... 一分钟揭秘辅助器!火鸟大厅辅助器多功能AI方法,火鸟大厅果然真的有辅助器方法1、火鸟大厅模拟器是什么...
总算了解透视器!天久大厅透视器... 总算了解透视器!天久大厅透视器多功能AI软件,天久大厅一贯真的有透视器软件1、许多玩家不知道天久大厅...
玩家实测透视器!美人透视器多功... 玩家实测透视器!美人透视器多功能AI技巧,美人竟然真的有透视器技巧1、玩家可以在美人线上大神俱乐部对...
必知教程透视器!新乐酷副厅透视... 必知教程透视器!新乐酷副厅透视器多功能AIapp,新乐酷副厅真是存在有透视器app1、该软件可以轻松...
热点推荐透视挂!新鸿狐透视挂多... 热点推荐透视挂!新鸿狐透视挂多功能AI工具,新鸿狐其实有透视挂工具1、新鸿狐透视辅助软件激活码多个强...
带你了解辅助!椰子大厅辅助多功... 带你了解辅助!椰子大厅辅助多功能AI攻略,椰子大厅总是真的有辅助攻略椰子大厅是不是有人用挂微扑克wp...
每日必看推荐作弊器!八戒大厅作... 每日必看推荐作弊器!八戒大厅作弊器多功能AI插件,八戒大厅竟然存在有作弊器插件八戒大厅破解侠是真的助...