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:
    

相关内容

热门资讯

记者发布!pokemmo修改器... 记者发布!pokemmo修改器手机版,wepoker私人辅助器,总是真的是有挂(有挂助手)1、操作简...
实测分享!德普之星透视辅助软件... 实测分享!德普之星透视辅助软件是真的吗,德州hhpoker脚本,真是是有挂(有挂分享)1、下载好脚本...
揭秘真相!wepoker辅助器... 揭秘真相!wepoker辅助器官方,we poker辅助器,本来真的有挂(有挂总结)1、wepoke...
科技通报!wepoker怎么增... 科技通报!wepoker怎么增加运气,HH平台挂,一贯真的有挂(有挂细节)亲,关键说明,透视脚本安卓...
技术分享!hhpoker有没有... 技术分享!hhpoker有没有辅助,hhpoker脚本,真是真的有挂(有挂方式)1、很好的工具软件,...
一分钟揭秘!pokemmo手机... 一分钟揭秘!pokemmo手机版修改器,大菠萝辅助器,原来真的是有挂(有挂总结)1、让任何用户在无需...
9分钟了解!wepoker透视... 9分钟了解!wepoker透视苹果系统,wepoker辅助透视软件,果然存在有挂(有挂教学)1、we...
免费测试版!werplan辅助... 免费测试版!werplan辅助软件,德普之星透视辅助软件,确实是有挂(真的有挂)辅助器是一种具有地方...
玩家实测!wepoker有辅助... 玩家实测!wepoker有辅助插件吗,wepoker透视脚本是什么,切实真的是有挂(有挂总结)1、打...
科普分享!wpk可以作弊吗,h... 科普分享!wpk可以作弊吗,hhpoker德州有挂吗,原来是有挂(有人有挂)1、进入到是否有挂之后,...