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:
    

相关内容

热门资讯

一分钟揭秘!hh poker有... 一分钟揭秘!hh poker有没有辅助软件!果然真的是有辅助教程(有挂总结);1、hh poker有...
总算清楚!八闽掌上辅助软件!都... 总算清楚!八闽掌上辅助软件!都是存在有辅助挂(有挂规律)1、八闽掌上辅助软件公共底牌简单,八闽掌上辅...
一分钟揭秘!凑一桌游戏插件!其... 一分钟揭秘!凑一桌游戏插件!其实是真的有辅助插件(讲解有挂)所有人都在同一条线上,像星星一样排成一排...
每日必看推荐!卡五星辅助神器!... 每日必看推荐!卡五星辅助神器!总是存在有辅助攻略(有挂辅助)1、卡五星辅助神器公共底牌简单,卡五星辅...
教程攻略!卡五星辅助器!确实是... 教程攻略!卡五星辅助器!确实是真的有辅助攻略(讲解有挂)1、用户打开应用后不用登录就可以直接使用,点...
玩家必用!微乐陕西小程序破解器... 玩家必用!微乐陕西小程序破解器下载!好像真的是有辅助神器(有挂透视)1、下载好微乐陕西小程序破解器下...
科技通报!天天贵阳辅助工具!总... 科技通报!天天贵阳辅助工具!总是真的是有辅助软件(真的有挂)1、天天贵阳辅助工具公共底牌简单,天天贵...
昨日!天天微友辅助器!竟然是真... 昨日!天天微友辅助器!竟然是真的有辅助软件(证实有挂)1、游戏颠覆性的策略玩法,独创攻略技巧玩法,可...
查到实测辅助!瑞安玉海楼茶苑辅... 查到实测辅助!瑞安玉海楼茶苑辅助器!都是真的是有辅助挂(今日头条)1、完成瑞安玉海楼茶苑辅助器有辅助...
科技介绍!科乐填大坑破解游戏!... 科技介绍!科乐填大坑破解游戏!竟然确实有辅助插件(有挂解惑)在进入科乐填大坑破解游戏软件靠谱后,参与...