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:
    

相关内容

热门资讯

透视攻略!德州局透视脚本,皮皮... 透视攻略!德州局透视脚本,皮皮辅助器(辅助)切实是真的有脚本(哔哩哔哩)皮皮辅助器能透视中分为三种模...
透视窍要!pokemmo辅助器... 透视窍要!pokemmo辅助器,中至抚州辅助软件(辅助)真是存在有插件(哔哩哔哩)1、下载好中至抚州...
透视演示!pokerworld... 透视演示!pokerworld辅助器,雀姬辅助(辅助)原来真的有教程(哔哩哔哩)1、雀姬辅助破解器简...
透视举措!impoker辅助,... 透视举措!impoker辅助,随意玩透视辅助软件(辅助)果然真的是有软件(哔哩哔哩)1、任何随意玩透...
透视模板!智星菠萝辅助,新道游... 透视模板!智星菠萝辅助,新道游科技透视通用版1(辅助)原来有教程(哔哩哔哩)1、进入游戏-大厅左侧-...
透视方式!werplan辅助软... 透视方式!werplan辅助软件,心悦填大坑技巧分析器(辅助)原来有教程(哔哩哔哩)1、透视方式!w...
透视窍要!哈糖大菠萝有挂吗5个... 透视窍要!哈糖大菠萝有挂吗5个常用方法,乐酷副厅有透视吗(辅助)竟然一直都是有技巧(哔哩哔哩)1、许...
透视法门!大菠萝免费辅助,福州... 透视法门!大菠萝免费辅助,福州天天开心辅助(辅助)一贯一直总是有攻略(哔哩哔哩)1、进入到福州天天开...
透视窍门!sohoo辅助,潮汕... 透视窍门!sohoo辅助,潮汕掌上娱透视脚本制作(辅助)其实有教程(哔哩哔哩)1、起透看视 潮汕掌上...
透视总结!约局吧德州有挂吗,陕... 透视总结!约局吧德州有挂吗,陕西三代二破解(辅助)原来一直都是有工具(哔哩哔哩)透视总结!约局吧德州...