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:
    

相关内容

热门资讯

玩家爆料作弊器方法!打两圈兴化... 玩家爆料作弊器方法!打两圈兴化麻将多功能作弊器方法,打两圈兴化麻将一直是真的有作弊器方法打两圈兴化麻...
重磅来袭辅助app!欢乐碰胡多... 重磅来袭辅助app!欢乐碰胡多功能辅助app,欢乐碰胡其实是有辅助app亲,关键说明,欢乐碰胡透视脚...
推荐一款开挂技巧!开心娱乐多功... 推荐一款开挂技巧!开心娱乐多功能开挂技巧,开心娱乐竟然存在有开挂技巧1、用户打开应用后不用登录就可以...
揭秘关于作弊器脚本!天天麻将九... 揭秘关于作弊器脚本!天天麻将九州多功能作弊器脚本,天天麻将九州一直是真的有作弊器脚本进入游戏-大厅左...
一分钟了解透视挂app!白金岛... 一分钟了解透视挂app!白金岛跑得快多功能透视挂app,白金岛跑得快竟然真的是有透视挂app小薇(辅...
分享一款透视器攻略!悠乐汇多功... 分享一款透视器攻略!悠乐汇多功能透视器攻略,悠乐汇竟然存在有透视器攻略1、每一步都需要思考,不同水平...
实测教程透视器插件!惜缘多功能... 实测教程透视器插件!惜缘多功能透视器插件,惜缘其实真的是有透视器插件1、全新机制【惜缘ai辅助工具激...
指导大家开挂app!广东麻将多... 指导大家开挂app!广东麻将多功能开挂app,广东麻将真是真的有开挂app1、打开软件启动之后找到中...
总算了解外挂脚本!天涯麻将多功... 总算了解外挂脚本!天涯麻将多功能外挂脚本,天涯麻将一贯真的有外挂脚本1、天涯麻将辅助软件下载优化,天...
记者爆料开挂脚本!天天麻将九州... 记者爆料开挂脚本!天天麻将九州多功能开挂脚本,天天麻将九州一直是真的有开挂脚本1、上手简单,内置详细...