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真能买... 透视揭露!hhpoker真能买到挂吗,hhpoker有没有辅助-一贯是有辅助app(哔哩哔哩)1、辅...
透视推荐!wpk是真的还是假的... 透视推荐!wpk是真的还是假的,wpk俱乐部有没有辅助-确实真的有辅助工具(哔哩哔哩)1、超多福利:...
透视解谜!pokermaste... 透视解谜!pokermaster破解版,云扑克有透视吗-竟然真的是有辅助工具(哔哩哔哩)1、下载好云...
透视解密!hhpoker辅助器... 透视解密!hhpoker辅助器,hhpoker的辅助是真的吗-竟然是有辅助技巧(哔哩哔哩)1、透视解...
透视了解!wpk德州局怎么透视... 透视了解!wpk德州局怎么透视,wpk真吗-果然存在有辅助攻略(哔哩哔哩)1、德州局怎么透视辅助软件...
透视揭幕!aapoker怎么控... 透视揭幕!aapoker怎么控制牌,aapoker透视脚本入口-果然有辅助app(哔哩哔哩)1、进入...
透视了解!微扑克微乐辅助,wp... 透视了解!微扑克微乐辅助,wpk俱乐部有没有辅助-一直是有辅助神器(哔哩哔哩)辅助器是一种具有地方特...
透视分享!wpk私人辅助,wp... 透视分享!wpk私人辅助,wpk私人局有透视吗-确实是有辅助脚本(哔哩哔哩)1)有没有挂:进一步探索...
透视曝光!wpk插件辅助,wp... 透视曝光!wpk插件辅助,wpk透视辅助靠谱吗-原来存在有辅助软件(哔哩哔哩)1、每一步都需要思考,...
透视科普!wpk俱乐部辅助器,... 透视科普!wpk俱乐部辅助器,如何下载wpk透视版-其实存在有辅助技巧(哔哩哔哩)该软件可以轻松地帮...