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:
    

相关内容

热门资讯

两分钟了解!边锋老友怎么开挂!... 两分钟了解!边锋老友怎么开挂!一贯是真的有辅助工具(有挂方法)-哔哩哔哩运边锋老友怎么开挂辅助工具,...
两分钟了解!聚友联盟!确实真的... 两分钟了解!聚友联盟!确实真的是有辅助方法(真实有挂)-哔哩哔哩1、进入游戏-大厅左侧-新手福利-激...
四分钟了解!优优乐破解!都是有... 四分钟了解!优优乐破解!都是有辅助攻略(有挂工具)-哔哩哔哩运优优乐破解辅助工具,进入游戏界面。进入...
第十分钟了解!海螺众娱脚本!好... 第十分钟了解!海螺众娱脚本!好像一直都是有辅助脚本(有挂辅助)-哔哩哔哩1、完成海螺众娱脚本有辅助插...
5分钟了解!纳祥游戏脚本!一直... 5分钟了解!纳祥游戏脚本!一直真的是有辅助教程(有挂详情)-哔哩哔哩1、该软件可以轻松地帮助玩家将纳...
九分钟了解!游戏茶苑辅助软件!... 九分钟了解!游戏茶苑辅助软件!切实有辅助app(有挂头条)-哔哩哔哩1、实时游戏茶苑辅助软件透视辅助...
六分钟了解!免费闲逸辅助器免费... 六分钟了解!免费闲逸辅助器免费!本来是真的有辅助方法(有挂技巧)-哔哩哔哩免费闲逸辅助器免费能透视中...
五分钟了解!多乐跑得私人房间插... 五分钟了解!多乐跑得私人房间插件!真是存在有辅助软件(有挂教程)-哔哩哔哩1、下载好多乐跑得私人房间...
8分钟了解!约战武汉辅助软件!... 8分钟了解!约战武汉辅助软件!一直存在有辅助教程(证实有挂)-哔哩哔哩1、进入游戏-大厅左侧-新手福...
两分钟了解!传送屋辅助器下载!... 两分钟了解!传送屋辅助器下载!一直真的是有辅助脚本(有挂攻略)-哔哩哔哩1、起透看视 传送屋辅助器下...