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:
    

相关内容

热门资讯

大神推荐!哈糖大菠萝软件下载,... 大神推荐!哈糖大菠萝软件下载,we poker游戏下,总是是有挂(有挂细节)1、上手简单,内置详细流...
一分钟教你!aa poker辅... 一分钟教你!aa poker辅助包,pokeplus脚本,好像真的是有挂(有挂讲解);1、完成辅助器...
来一盘!wepoker的辅助器... 来一盘!wepoker的辅助器,wpk透视工作室,真是存在有挂(揭秘有挂)1、玩家可以在线上大神俱乐...
科技分享!pokermaste... 科技分享!pokermaster修改器,wepoker游戏安装教程,其实真的是有挂(有挂规律)1、操...
一分钟了解!德普之星辅助工具如... 一分钟了解!德普之星辅助工具如何打开,wepoker免费脚本,都是是真的有挂(有挂讲解);1、wep...
实测分享!wepokerplu... 实测分享!wepokerplus脚本,aapoker怎么选牌,原来真的是有挂(有挂教学)1、这是跨平...
玩家必备教程!hhpoker可... 玩家必备教程!hhpoker可以控制牌吗,德州局透视脚本,一直存在有挂(有挂技巧)1、让任何用户在无...
如何分辨真伪!wepoker有... 如何分辨真伪!wepoker有辅助吗,hhpoker是真的还是假的,竟然有挂(有挂解惑)1、任何透视...
避坑细节!wepoker透视a... 避坑细节!wepoker透视app下载,HH平台挂,果然是真的有挂(证实有挂)亲,关键说明,透视脚本...
重大通报!wejoker辅助器... 重大通报!wejoker辅助器要钱玩吗,wepoker挂,一直有挂(确实有挂)1、任何透视是真的假的...