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透视工作室,w... 透视解谜!wpk透视工作室,wpk透视插件(透视)竟然是有工具(哔哩哔哩)脚本下载中分为三种模型:挂...
透视有挂!aapoker破解侠... 透视有挂!aapoker破解侠是真的吗,aapoker ai插件(透视)本来是有教程(哔哩哔哩)1、...
透视揭幕!德普之星透视辅助软件... 透视揭幕!德普之星透视辅助软件激活码,德普之星透视软件免费入口官网(透视)本来存在有app(哔哩哔哩...
脚本必备!如何下载德普之星辅助... 脚本必备!如何下载德普之星辅助软件,德普辅助软件(透视)好像真的有攻略(哔哩哔哩)1、免费辅助多个强...
脚本推荐!aapoker公共底... 脚本推荐!aapoker公共底牌,aapoker辅助怎么用(透视)一贯是有器(哔哩哔哩)1、金币登录...
透视开挂!wpk系统是否存在作... 透视开挂!wpk系统是否存在作必弊行为,wpk有辅助器吗(透视)本来真的有技巧(哔哩哔哩)1、透视开...
透视必备!aapoker透视方... 透视必备!aapoker透视方法,aapoker能控制牌吗(透视)原来有脚本(哔哩哔哩)该软件可以轻...
透视教你!aapoker怎么选... 透视教你!aapoker怎么选牌,aapoker透视脚本入口(透视)好像存在有教程(哔哩哔哩)1)有...
透视详细!wpk透视是真的假的... 透视详细!wpk透视是真的假的,wpk作必弊最怕三个东西(透视)果然真的是有教程(哔哩哔哩)暗藏猫腻...
透视透视!wpk软件是真的吗,... 透视透视!wpk软件是真的吗,wpk软件是正规的吗(透视)切实真的是有技巧(哔哩哔哩)1、每一步都需...