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:
    

相关内容

热门资讯

大家学习交流!wepoker透... 大家学习交流!wepoker透视苹果系统,德普之星辅助工具如何设置,好像是有挂(有挂详细)运辅助工具...
安装程序教程!wepokerp... 安装程序教程!wepokerplus万能挂,wpk透视插件,切实是真的有挂(有挂分析)1、玩家可以在...
推荐十款!wepoker如何设... 推荐十款!wepoker如何设置透视,wepoker智能辅助插件,竟然是真的有挂(有挂助手)1、we...
推荐十款!wepoker手机版... 推荐十款!wepoker手机版透视脚本,wepoker游戏下载,好像存在有挂(有挂秘笈)1、操作简单...
一分钟了解!德州透视插件,we... 一分钟了解!德州透视插件,wepoker私人局辅助器怎么用,切实是真的有挂(确实有挂)暗藏猫腻,小编...
推荐一款!德普之星透视辅助,w... 推荐一款!德普之星透视辅助,wepoker软件靠谱么,果然有挂(有挂方法)1、这是跨平台的轻量版有透...
发现一款!wepoker有没有... 发现一款!wepoker有没有透视方法,扑克之星辅助,其实是有挂(有挂教程)1、任何透视是真的假的的...
重大推荐!德州透视插件,pok... 重大推荐!德州透视插件,pokemmo手机版脚本,一贯真的有挂(新版有挂)1、用户打开应用后不用登录...
玩家交流!wepoker轻量版... 玩家交流!wepoker轻量版辅助,wepoker软件辅助程序,果然真的有挂(详细教程)1. 选牌创...
玩家攻略推荐!pokemmo手... 玩家攻略推荐!pokemmo手机辅助软件,hhpoker底牌透视脚本,真是真的是有挂(有挂教程)一、...