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:
    

相关内容

热门资讯

第8分钟了解!余干辅助软件哪个... 第8分钟了解!余干辅助软件哪个好!原来是真的有辅助插件(有挂总结)-哔哩哔哩1、上手简单,内置详细流...
第9分钟了解!牵手跑辅助!一贯... 第9分钟了解!牵手跑辅助!一贯真的是有辅助神器(有挂技巧)-哔哩哔哩1、牵手跑辅助辅助器安装包、牵手...
两分钟了解!浙江游戏温州熟客辅... 两分钟了解!浙江游戏温州熟客辅助!切实一直都是有辅助插件(果真有挂)-哔哩哔哩1、每一步都需要思考,...
第三分钟了解!海螺众娱脚本!真... 第三分钟了解!海螺众娱脚本!真是是真的有辅助教程(有挂解密)-哔哩哔哩1)海螺众娱脚本免费钻石:进一...
十分钟了解!决战血流辅助!一贯... 十分钟了解!决战血流辅助!一贯一直都是有辅助技巧(有挂详情)-哔哩哔哩运决战血流辅助辅助工具,进入游...
四分钟了解!开心泉州作必弊!果... 四分钟了解!开心泉州作必弊!果然存在有辅助技巧(有挂细节)-哔哩哔哩1、开心泉州作必弊透视辅助软件激...
三分钟了解!情怀麻烦将关春天辅... 三分钟了解!情怀麻烦将关春天辅助!其实一直总是有辅助神器(有挂教学)-哔哩哔哩1、完成情怀麻烦将关春...
8分钟了解!福建十三水软件开发... 8分钟了解!福建十三水软件开发!一直有辅助工具(有挂秘诀)-哔哩哔哩该软件可以轻松地帮助玩家将福建十...
九分钟了解!手游奇迹陕西辅助工... 九分钟了解!手游奇迹陕西辅助工具!果然一直都是有辅助方法(真实有挂)-哔哩哔哩该软件可以轻松地帮助玩...
第5分钟了解!微信海豚大厅辅助... 第5分钟了解!微信海豚大厅辅助!总是一直总是有辅助软件(证实有挂)-哔哩哔哩该软件可以轻松地帮助玩家...