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,微乐小程序破解版修改器-都是有辅助挂(有挂方法)1、完成微乐...
我来教教你!微乐小程序游戏破解... 我来教教你!微乐小程序游戏破解器,微乐小程序免费脚本-竟然有辅助app(揭秘有挂)1、起透看视 微乐...
科技揭秘!微乐小程序游戏破解器... 您好,微乐小程序游戏破解器这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很...
免费测试版!微信微乐小程序修改... 免费测试版!微信微乐小程序修改器,手机微乐小程序破解器如何使用-原来真的有辅助工具(有挂方式)1、完...
必知教程!微乐小程序免费工具,... 必知教程!微乐小程序免费工具,微乐江苏自建房辅助app-都是存在有辅助挂(有挂秘诀)1、微乐小程序免...
推荐十款!微乐小程序脚本工具平... 推荐十款!微乐小程序脚本工具平台,微信小程序微乐辅助-果然是真的有辅助app(有挂讲解)1、玩家可以...
今日科普!微信小程序微乐辅助器... 今日科普!微信小程序微乐辅助器,微乐广西麻辣辅助器-原来是有辅助教程(有挂方法)1、游戏颠覆性的策略...
玩家必看科普!微乐小程序家乡自... 玩家必看科普!微乐小程序家乡自建房辅助app,微乐自建房辅助可信吗-确实是有辅助技巧(有挂透视)一、...
一分钟揭秘!微信微乐小程序有挂... 一分钟揭秘!微信微乐小程序有挂黑科技,微乐家乡官方免费下载安装-真是真的有辅助攻略(有挂分析)1、微...
普及知识!微信微乐小程序辅助器... 普及知识!微信微乐小程序辅助器免费安装,微信微乐陕西小程序破解器-都是有辅助插件(新版有挂)1)微信...