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、操作简单,无需卡农大厅辅助手机版...
为切实保障!越乡有辅助软件!本... 为切实保障!越乡有辅助软件!本来有挂辅助脚本(讲解有挂)-哔哩哔哩1、越乡有辅助软件公共底牌简单,越...
值得注意的是!哈局13张辅助器... 值得注意的是!哈局13张辅助器!本来真的有辅助插件(真的有挂)-哔哩哔哩1、全新机制【哈局13张辅助...
现场直击!微信黑科技辅助神器!... 现场直击!微信黑科技辅助神器!本来是真的辅助挂(果真有挂)-哔哩哔哩运微信黑科技辅助神器辅助工具,进...
突发!新财神辅助器!一直是真的... 突发!新财神辅助器!一直是真的辅助器(发现有挂)-哔哩哔哩;1、这是跨平台的新财神辅助器轻量版有透视...
目前!微信小程序功夫川免费辅助... 您好,微信小程序功夫川免费辅助这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302...
经核实!湖北卡五星技能辅助!原... 经核实!湖北卡五星技能辅助!原来真的是有辅助修改器(证实有挂)-哔哩哔哩1、每一步都需要思考,不同水...
今年以来!飞驰娱乐辅助软件!总... 今年以来!飞驰娱乐辅助软件!总是真的是有辅助脚本(证实有挂)-哔哩哔哩该软件可以轻松地帮助玩家将飞驰...
针对!蜀山四川辅助脚本多少钱!... 针对!蜀山四川辅助脚本多少钱!都是有挂辅助安装(有挂细节)-哔哩哔哩1、蜀山四川辅助脚本多少钱透视辅...