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:
    

相关内容

热门资讯

最新消息!wpk辅助软件,德扑... 最新消息!wpk辅助软件,德扑之星透视,竟然是有挂(有挂教程)1、每一步都需要思考,不同水平的挑战德...
我来教教你!wepoker私局... 我来教教你!wepoker私局辅助,购买wepoker模拟器,其实存在有挂(新版有挂)1、任何透视是...
明白辅助挂!wepoker私人... 明白辅助挂!wepoker私人局可以透视,德普之星辅助软件,都是真的有挂(有挂秘笈)1、首先打开德普...
详细说明!红龙poker有辅助... 详细说明!红龙poker有辅助吗,hhpoker作弊实战视频,果然有挂(有挂方法)1、玩家可以在线上...
出现新变化!哈糖大菠萝有挂吗,... 出现新变化!哈糖大菠萝有挂吗,德普之星app安卓版破解版,一贯真的有挂(有挂工具);1、下载好德普之...
终于清楚!约局吧作弊脚本,we... 终于清楚!约局吧作弊脚本,wepoker可以免费玩吗,本来有挂(有挂分析)1、不需要AI权限,帮助你...
推荐十款!wepoker如何设... 推荐十款!wepoker如何设置透视,wepoker科技辅助器,原来是真的有挂(有挂方针)1)有没有...
第三方技巧!wepoker私人... 第三方技巧!wepoker私人局可以透视,德普之星app安卓版破解版,原来是有挂(有挂细节)暗藏猫腻...
记者获悉!wepokerplu... 记者获悉!wepokerplus辅助,德普之星透视辅助插件,一贯真的有挂(真是有挂)1、很好的工具软...
总算了解!wepoker软件靠... 您好,这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很多玩家在这款游戏中打...