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、起透看视 德州之星透明视辅助2、...
黑科技代打(wepOkE)黑科... 黑科技代打(wepOkE)黑科技透明挂辅助挂(透视)透牌教程(竟然真的是有挂)1、用户打开应用后不用...
黑科技系统!(aapokEr)... 黑科技系统!(aapokEr)透明挂辅助器,(AAPOkER)从来真的有挂,2025版教程(有挂技巧...
黑科技工具(we poker)... 黑科技工具(we poker)黑科技透明挂辅助软件(透视)黑科技教程(一直是真的有挂)1、不需要AI...
黑科技讲解!(德扑)外挂辅助a... 黑科技讲解!(德扑)外挂辅助app,(德扑)原来存在有挂,解密教程(有挂方法);致您一封信;亲爱德扑...
黑科技攻略(红龙扑克)外挂辅助... 黑科技攻略(红龙扑克)外挂辅助方法(透视)揭秘教程(其实有挂)1、红龙扑克透视辅助简单,红龙扑克软件...
黑科技有挂!(wEpoKe)软... 黑科技有挂!(wEpoKe)软件透明挂,(WePoKer)素来是有挂,解说技巧(有挂技巧),支持语音...
黑科技好牌(微扑克私人局)外挂... 黑科技好牌(微扑克私人局)外挂透视辅助神器(透视)新2025教程(总是是真的有挂);1、该软件可以轻...
黑科技插件!(wPK)透视辅助... 黑科技插件!(wPK)透视辅助器,(wpK)原生存在有挂,攻略教程(有挂教程);《WPK辅助透视》‌...
黑科技线上(WepOke)黑科... 黑科技线上(WepOke)黑科技透明挂辅助挂(透视)可靠技巧(一直真的是有挂)1、用户打开应用后不用...