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:
    

相关内容

热门资讯

一分钟揭秘!德普之星辅助挂多功... 一分钟揭秘!德普之星辅助挂多功能透视工具,好像真的是有挂(有挂方法)该软件可以轻松地帮助玩家将德普之...
玩家必看科普!wpk辅助挂多功... 玩家必看科普!wpk辅助挂多功能透视工具,果然是有挂(有挂解密)所有人都在同一条线上,像星星一样排成...
实测交流!红龙poker辅助挂... 实测交流!红龙poker辅助挂多功能透视工具,好像存在有挂(有挂详情)1)红龙poker辅助插件:进...
总算了解!AAPoKer辅助挂... 总算了解!AAPoKer辅助挂多功能透视工具,切实是真的有挂(有挂存在)1、AAPoKer免费脚本咨...
教程攻略!wpk辅助挂多功能透... 教程攻略!wpk辅助挂多功能透视工具,一直真的是有挂(有挂实锤)1、任何wpk透视是真的假的的玩家都...
记者揭秘!aapoker辅助挂... 记者揭秘!aapoker辅助挂多功能透视工具,好像是有挂(有挂助手)1、下载好aapoker透视辅助...
科普!aapoker辅助挂多功... 科普!aapoker辅助挂多功能透视工具,本来是真的有挂(有挂秘籍)1、起透看视 aapoker辅助...
实测发现!aapoker辅助挂... 实测发现!aapoker辅助挂多功能透视工具,原来真的是有挂(有挂功能)1、aapoker透视辅助软...
今日科普!德普之星辅助挂多功能... 今日科普!德普之星辅助挂多功能透视工具,本来是真的有挂(真的有挂)1、首先打开德普之星辅助器下载最新...
每日必看推荐!WPK辅助挂多功... 每日必看推荐!WPK辅助挂多功能透视工具,果然真的有挂(有挂助手)1、WPK破解器简单,WPK机器人...