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:
    

相关内容

热门资讯

记者揭秘!智星菠萝辅助(透视辅... 记者揭秘!智星菠萝辅助(透视辅助)拱趴大菠萝辅助神器,扑克教程(有挂细节);模式供您选择,了解更新找...
一分钟揭秘!约局吧能能开挂(透... 一分钟揭秘!约局吧能能开挂(透视辅助)hhpoker辅助靠谱,2024新版教程(有挂教学);约局吧能...
透视辅助!wepoker模拟器... 透视辅助!wepoker模拟器哪个好用(脚本)hhpoker辅助挂是真的,科技教程(有挂技巧);囊括...
透视代打!hhpkoer辅助器... 透视代打!hhpkoer辅助器视频(辅助挂)pokemmo脚本辅助,2024新版教程(有挂教程);风...
透视了解!约局吧德州真的有透视... 透视了解!约局吧德州真的有透视挂(透视脚本)德州局HHpoker透视脚本,必胜教程(有挂分析);亲,...
六分钟了解!wepoker挂底... 六分钟了解!wepoker挂底牌(透视)德普之星开辅助,详细教程(有挂解密);德普之星开辅助是一种具...
9分钟了解!wpk私人辅助(透... 9分钟了解!wpk私人辅助(透视)hhpoker德州透视,插件教程(有挂教学);风靡全球的特色经典游...
推荐一款!wepoker究竟有... 推荐一款!wepoker究竟有透视(脚本)哈糖大菠萝开挂,介绍教程(有挂技术);囊括全国各种wepo...
每日必备!wepoker有人用... 每日必备!wepoker有人用过(脚本)wpk有那种辅助,线上教程(有挂规律);wepoker有人用...
玩家必备教程!wejoker私... 玩家必备教程!wejoker私人辅助软件(脚本)哈糖大菠萝可以开挂,可靠技巧(有挂神器)申哈糖大菠萝...