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:
    

相关内容

热门资讯

热门推荐辅助!天天卡五星辅助A... 热门推荐辅助!天天卡五星辅助AI攻略,天天卡五星多功能本来是真的有辅助攻略1、许多玩家不知道天天卡五...
一分钟了解作弊器!MG棋牌作弊... 一分钟了解作弊器!MG棋牌作弊器AI教程,MG棋牌多功能一直真的是有作弊器教程MG棋牌破解侠是真的助...
最新技巧外挂!新道游外挂AI工... 最新技巧外挂!新道游外挂AI工具,新道游多功能确实有外挂工具1、操作简单,无需新道游手机版透视脚本,...
查到实测辅助作弊器!新爵互娱作... 查到实测辅助作弊器!新爵互娱作弊器AI技巧,新爵互娱多功能其实真的是有作弊器技巧1、新爵互娱免费脚本...
科普常识开挂!起点休闲开挂AI... 科普常识开挂!起点休闲开挂AI技巧,起点休闲多功能一贯有开挂技巧1、起点休闲公共底牌简单,起点休闲透...
教学盘点透视挂!八喜休闲透视挂... 教学盘点透视挂!八喜休闲透视挂AI教程,八喜休闲多功能本来真的是有透视挂教程1、许多玩家不知道八喜休...
玩家必看透视挂!富友茶苑透视挂... 玩家必看透视挂!富友茶苑透视挂AI脚本,富友茶苑多功能本来有透视挂脚本富友茶苑辅助器是一种具有地方特...
玩家必备科技辅助器!友空互娱辅... 玩家必备科技辅助器!友空互娱辅助器AI方法,友空互娱多功能竟然有辅助器方法1、友空互娱模拟器是什么优...
今日公布外挂!百川外挂AI方法... 今日公布外挂!百川外挂AI方法,百川多功能都是真的是有外挂方法1、任何百川透视是真的假的的玩家都可以...
揭秘一下外挂!兴动游戏外挂AI... 揭秘一下外挂!兴动游戏外挂AI教程,兴动游戏多功能确实有外挂教程;1、在兴动游戏插件功能辅助器技巧中...