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好友助力码,wepoker底牌透视(都是是真的有挂)1、每一步都需要思考,不...
透视ai代打!wepoker养... 透视ai代打!wepoker养号规律,wepoker有没有挂(果然是真的有挂)1、wepoker有没...
透视科技!wepoker辅助器... 透视科技!wepoker辅助器软件下载,wepoker游戏安装教程(一贯是真的有挂)1、下载好wep...
透视能赢!wepoker透视有... 透视能赢!wepoker透视有没有,wepoker俱乐部辅助器(果然有挂);1)wepoker俱乐部...
透视攻略!wepoker怎么下... 透视攻略!wepoker怎么下载游戏,wepoker怎么破解游戏(本来真的有挂)wepoker怎么破...
透视透视!wepoker轻量版... 透视透视!wepoker轻量版书签,wepoker有透视吗(原来是真的有挂)1、进入游戏-大厅左侧-...
透视中牌率!wepoker免费... 透视中牌率!wepoker免费脚本咨询,wepoker怎么提高运气(一直真的有挂)1、每一步都需要思...
透视辅助!wepoker可以免... 透视辅助!wepoker可以免费玩吗,wepokerplus作弊(一直存在有挂);1)wepoker...
透视最新!wepoker辅助真... 透视最新!wepoker辅助真的假的,wepoker黑侠辅助器(都是真的是有挂)1、打开软件启动之后...
透视了解!wepokerplu... 透视了解!wepokerplus到底是挂了吗,wepoker私人局俱乐部辅助(都是是真的有挂)1、w...