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插件下载,德普之星透视辅助软件,果然确实有挂(有挂透明挂)1、起透看视 ...
2026版攻略!aapoker... 2026版攻略!aapoker脚本怎么用,德普之星透视辅助软件激活码,切实确实有挂(有挂猫腻)1、德...
据文件显示!wepoker破解... 据文件显示!wepoker破解器有用吗,德普之星透视辅助软件,真是是有挂(有挂辅助)1、玩家可以在德...
此事迅速冲上热搜!wepoke... 此事迅速冲上热搜!wepoker怎么提高运气,德扑之星辅助工具如何设置,真是存在有挂(有挂教学)一、...
昨日!hardrock作弊,德... 昨日!hardrock作弊,德普之星透视辅助,都是确实有挂(的确有挂)1、德普之星透视辅助免费脚本咨...
突发!智星菠萝辅助,红龙pok... 突发!智星菠萝辅助,红龙poker辅助,确实真的是有挂(有人有挂)1、操作简单,无需智星菠萝辅助手机...
据统计!红龙poker有辅助吗... 据统计!红龙poker有辅助吗,德扑之星有透视辅助吗,确实真的有挂(有挂神器)1、玩家可以在德扑之星...
软件辅助挂!wepoker网页... 软件辅助挂!wepoker网页版透视方法,智星德州可以透视吗,切实是真的有挂(有挂解惑)软件辅助挂!...
教学辅助挂!wepoker透视... 教学辅助挂!wepoker透视底牌脚本,德普辅助软件,竟然是有挂(有挂透视)1、点击下载安装,德普辅...
来临!aapoker怎么提高中... 来临!aapoker怎么提高中牌率,红龙poker辅助,本来真的是有挂(有挂教学)1、玩家可以在红龙...