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)微乐兰州麻将小程序辅...
一分钟揭秘!微乐小程序免费黑科... 一分钟揭秘!微乐小程序免费黑科技是真的吗(辅助器),微乐刨幺填大坑果然真的有透视挂教程1、很好的工具...
分享一款!微乐小程序免费脚本(... 分享一款!微乐小程序免费脚本(外挂),微乐卡五星一贯真的是有透视挂技巧1、该软件可以轻松地帮助玩家将...
玩家必看分享!微乐小程序黑科技... 玩家必看分享!微乐小程序黑科技辅助工具推荐(开挂),微乐捉鸡麻将果然是有透视挂脚本1、全新机制【微乐...
安装程序教程!微乐小程序辅助器... 安装程序教程!微乐小程序辅助器脚本(作弊器),微乐河南红中麻将本来有透视挂app所有人都在同一条线上...
技术分享!微乐小程序辅助开挂(... 技术分享!微乐小程序辅助开挂(辅助),微乐河北麻将一直有透视挂插件1、微乐小程序辅助开挂模拟器是什么...