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、德普辅助软件系统规律教程、德普辅助软件辅助透视...
透视攻略!aapoker公共底... 透视攻略!aapoker公共底牌(透视)辅助插件工具(原来存在有挂)1、上手简单,内置详细流程视频教...
透视玄学!如何下载德普之星辅助... 透视玄学!如何下载德普之星辅助软件(透视)私人局透视(好像存在有挂)1、上手简单,内置详细流程视频教...
透视app!aapoker辅助... 透视app!aapoker辅助插件工具(透视)透视软件(总是真的是有挂);1、下载好aapoker辅...
透视透视!德普之星透视辅助软件... 透视透视!德普之星透视辅助软件(透视)透视(一贯真的有挂)1、构建自己的德普之星透视辅助软件辅助插件...
透视好友房!aapoker插件... 透视好友房!aapoker插件(透视)ai插件(总是存在有挂);1、每一步都需要思考,不同水平的挑战...
透视好友!德普之星有透视辅助吗... 透视好友!德普之星有透视辅助吗(透视)透视软件免费入口官网(本来有挂);1、起透看视 德普之星有透视...
透视脚本!aapoker安装包... 透视脚本!aapoker安装包怎么使用(透视)插件下载(原来是真的有挂);小薇(透视辅助)致您一封信...
透视真的!德普之星透视辅助(透... 透视真的!德普之星透视辅助(透视)透视(一直存在有挂);1、玩家可以在德普之星透视辅助软件透明挂俱乐...
透视真的!aapoker真的假... 透视真的!aapoker真的假的(透视)免费透视脚本(都是真的是有挂)1、aapoker真的假的系统...