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、任何欢喜麻将透视是真的假的的玩家都可以机...
黑科技代打!老铁联盟辅助透视挂... 黑科技代打!老铁联盟辅助透视挂,圣盛晃晃麻将是真的有挂,切实真的有挂1、玩家可以在圣盛晃晃麻将线上大...
日前!乐友辅助透视挂,杭乐麻将... 日前!乐友辅助透视挂,杭乐麻将确实有挂,本来证实有挂1、乐友模拟器是什么优化,乐友俱乐部是真的科技护...
长期以来!挪扎传奇辅助透视挂,... 长期以来!挪扎传奇辅助透视挂,呼包鄂游戏确实有挂,一直果真有挂1、金币登录送、破产送、升级送、活动送...
有消息称!新蜜瓜辅助透视挂,吉... 有消息称!新蜜瓜辅助透视挂,吉米是真的有挂,真是有挂细节所有人都在同一条线上,像星星一样排成一排,每...
目前来看!多乐互动辅助透视挂,... 目前来看!多乐互动辅助透视挂,汇友存在有挂,总是今日头条1、多乐互动辅助软件下载优化,多乐互动底牌透...
有了最新消息!微乐吉林麻将辅助... 有了最新消息!微乐吉林麻将辅助透视挂,大众互娱真的是有挂,都是有挂分享1、进入到微乐吉林麻将是否有挂...
目前!欢乐龙城棋牌辅助透视挂,... 目前!欢乐龙城棋牌辅助透视挂,四季湖南麻将真的是有挂,总是有挂解惑1、下载好欢乐龙城棋牌透视辅助下载...
复盘辅助挂!云水谣辅助透视挂,... 复盘辅助挂!云水谣辅助透视挂,超凡联盟真的是有挂,好像有挂透明挂1、云水谣辅助软件下载优化,云水谣底...
日前!丰城麻将辅助透视挂,兴动... 日前!丰城麻将辅助透视挂,兴动友圈真的是有挂,都是确实有挂该软件可以轻松地帮助玩家将丰城麻将外卦神器...