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:
    

相关内容

热门资讯

免费测试版!wejoker辅助... 免费测试版!wejoker辅助软件视频(辅助挂)本来是真的有挂(有挂辅助辅助插件)1、上手简单,内置...
最新技巧!hhpkoer辅助挂... 最新技巧!hhpkoer辅助挂是真的吗(辅助挂)好像存在有挂(有挂透明挂辅助教程)1、起透看视 辅助...
科技通报!佛手在线大菠萝辅助(... 科技通报!佛手在线大菠萝辅助(辅助挂)真是存在有挂(确实有挂辅助器)1、上手简单,内置详细流程视频教...
玩家攻略!cloudpoker... 玩家攻略!cloudpoker作弊(辅助挂)真是是真的有挂(有挂技术辅助软件)1、进入到是否有挂之后...
科技通报!wpk可以作弊吗(辅... 科技通报!wpk可以作弊吗(辅助挂)真是有挂(有挂解密辅助软件)1、起透看视 辅助软件价格2、随意选...
发现玩家!htx矩阵wepok... 发现玩家!htx矩阵wepoker辅助(辅助挂)其实存在有挂(有挂规律辅助方法)1)免费钻石:进一步...
分享一款!hhpoker脚本(... 分享一款!hhpoker脚本(辅助挂)好像是有挂(有挂秘籍辅助脚本)1、起透看视 辅助软件价格2、随...
科技新动态!wepoker辅助... 科技新动态!wepoker辅助插件功能(辅助挂)其实真的是有挂(揭秘有挂辅助工具)1、实时透视辅助更...
一分钟了解!约局吧德州真的有透... 一分钟了解!约局吧德州真的有透视挂吗(辅助挂)真是真的是有挂(真的有挂辅助插件)1、一分钟了解!约局...
实测教程!wpk安卓下载辅助(... 实测教程!wpk安卓下载辅助(辅助挂)真是有挂(有挂功能辅助器)1、起透看视 辅助软件价格2、随意选...