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、德普辅助软件免费脚本咨...
一分钟了解!德州之星扫描器,哈... 一分钟了解!德州之星扫描器,哈糖大菠萝可以开挂吗,好像存在有挂(有挂方法)1、首先打开辅助器下载最新...
2026版技巧!werplan... 2026版技巧!werplan怎么作弊,德扑之星有辅助软件吗,果然是有挂(发现有挂)1、任何德扑之星...
我来教大家!德州透视是真的吗,... 我来教大家!德州透视是真的吗,来玩app 德州 辅助,都是有挂(有挂辅助)1、金币登录送、破产送、升...
据目击者称!wepoker私人... 据目击者称!wepoker私人局外卦,智星德州插件2024最新版,总是真的有挂(有挂分析)暗藏猫腻,...
重大通报!wpk辅助是什么,a... 重大通报!wpk辅助是什么,aapoker脚本怎么用,切实是真的有挂(详细教程)1、全新机制【ai辅...
今日!wpk辅助购买,德普之星... 今日!wpk辅助购买,德普之星app安卓版破解版,好像确实有挂(有挂教程)1、德普之星app安卓版破...
一分钟了解!wepoker私人... 一分钟了解!wepoker私人局透视方法,wepoker透视有用吗,果然有挂(真的有挂)1、辅助器安...
随着!拱趴大菠萝挂怎么安装,智... 随着!拱趴大菠萝挂怎么安装,智星菠萝可以辅助吗,总是真的是有挂(有挂秘诀)1、进入游戏-大厅左侧-新...
2分钟细说!wepoker轻量... 2分钟细说!wepoker轻量版有透视吗,wepoker透视脚本视频,竟然是有挂(有挂详情)1、公共...