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买钻石有用吗,德普辅助软件,都是是真的有挂(了解有挂)德普辅助软件脚本下...
近期!hhpoker为什么一直... 近期!hhpoker为什么一直输,智星德州插件2024最新版,真是是真的有挂(了解有挂)1、下载好智...
据报道!wepoker透视有吗... 据报道!wepoker透视有吗,德扑之星怎么开辅助,一直真的是有挂(有挂实锤)1、许多玩家不知道德扑...
黑科技教程!约局吧德州透视,德... 黑科技教程!约局吧德州透视,德扑圈有透视吗,竟然真的有挂(新版有挂)德扑圈有透视吗辅助器是一种具有地...
教学辅助挂!wepoker有人... 教学辅助挂!wepoker有人用过吗,德扑之星透视辅助软件激活码,其实真的有挂(有挂存在)德扑之星透...
据目击者称!拱趴大菠萝自动计算... 据目击者称!拱趴大菠萝自动计算机器人,德扑之星的辅助工具介绍,都是确实有挂(有挂技术)德扑之星的辅助...
昨日!智星菠萝透视,德扑之星透... 昨日!智星菠萝透视,德扑之星透视,本来存在有挂(确实有挂)1、玩家可以在智星菠萝透视透视最简单三个步...
有消息称!we poker免费... 有消息称!we poker免费辅助器,智星德州插件怎么下载,一直是有挂(今日头条)1、智星德州插件怎...
这一现象值得深思!hhpoke... 您好,智星德州插件最新版本更新内容详解这款游戏可以开挂的,确实是有挂的,需要了解加去威信【13670...
此事引发广泛关注!哈糖大菠萝软... 此事引发广泛关注!哈糖大菠萝软件下载,德扑之星私人局辅助免费,都是是有挂(详细教程);1、下载好德扑...