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、起透看视 边锋老...
黑科技辅助器!打牌网(辅助器)... 黑科技辅助器!打牌网(辅助器),微信十三水好像有透视挂app(有辅助挂细节)1、微信十三水免费辅助多...
黑科技透视器!微微娱乐(透视器... 黑科技透视器!微微娱乐(透视器),安徽麻将本来真的有透视挂插件(有辅助挂细节)1、点击下载安装,安徽...
黑科技外挂!英豪娱乐城(外挂)... 黑科技外挂!英豪娱乐城(外挂),老地方好像有透视挂方法(有辅助挂讲解)1、英豪娱乐城透视辅助软件激活...
黑科技开挂!天空麻将(开挂),... 黑科技开挂!天空麻将(开挂),越乡游义乌麻将一直真的有透视挂攻略(有辅助挂实锤);1.越乡游义乌麻将...
黑科技作弊器!乐天棋牌(作弊器... 黑科技作弊器!乐天棋牌(作弊器),即赢互动竟然是真的有透视挂教程(有辅助挂透视)即赢互动脚本下载中分...
黑科技开挂!王者棋牌(开挂),... 黑科技开挂!王者棋牌(开挂),长乐互娱好像有透视挂app(确实有辅助挂)1、操作简单,无需王者棋牌手...
黑科技透视挂!飘飘(透视挂),... 黑科技透视挂!飘飘(透视挂),假日娱乐果然真的有透视挂插件(有辅助挂攻略)1、黑科技透视挂!飘飘(透...
黑科技透视挂!辰鸿(透视挂),... 黑科技透视挂!辰鸿(透视挂),奉化南塘一直真的是有透视挂教程(有辅助挂攻略)1)奉化南塘有没有挂:进...
黑科技透视器!新八戒牌九(透视... 黑科技透视器!新八戒牌九(透视器),大富翁都是真的是有透视挂app(有辅助挂细节)1、实时新八戒牌九...