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:
    

相关内容

热门资讯

发现一款!aapoker辅助挂... 发现一款!aapoker辅助挂多功能透视工具,本来是真的有挂(有挂细节)aapoker能透视中分为三...
技术分享!wepoker辅助挂... 技术分享!wepoker辅助挂多功能透视工具,确实是有挂(有挂技术)亲,关键说明,wepoker透视...
重磅来袭!微扑克辅助挂多功能透... 重磅来袭!微扑克辅助挂多功能透视工具,其实有挂(有挂工具)1、操作简单,无需微扑克手机版透视脚本,只...
总算明白!WPK辅助挂多功能透... 总算明白!WPK辅助挂多功能透视工具,确实是真的有挂(有挂秘诀)1)WPK有没有挂:进一步探索WPK...
带你了解!德扑圈辅助挂多功能透... 带你了解!德扑圈辅助挂多功能透视工具,真是存在有挂(真是有挂)德扑圈脚本下载中分为三种模型:德扑圈挂...
一分钟快速了解!wpk辅助挂多... 一分钟快速了解!wpk辅助挂多功能透视工具,原来真的是有挂(有挂教学)1、许多玩家不知道wpk辅助怎...
实测教程!AAPoKer辅助挂... 实测教程!AAPoKer辅助挂多功能透视工具,果然是真的有挂(有挂细节);1、进入游戏-大厅左侧-新...
研究成果!德扑之星辅助挂多功能... 研究成果!德扑之星辅助挂多功能透视工具,原来存在有挂(有挂方略)德扑之星破解侠是真的助透视。每个模型...
必知教程!微扑克辅助挂多功能透... 必知教程!微扑克辅助挂多功能透视工具,其实真的是有挂(有挂猫腻)1、实时微扑克透视辅助更新:用户可以...
玩家必备教程!德扑之星辅助挂多... 玩家必备教程!德扑之星辅助挂多功能透视工具,一直真的是有挂(有挂解密)德扑之星辅助器是一种具有地方特...