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:
    

相关内容

热门资讯

十分钟绝活儿!约战竞技场辅助器... 十分钟绝活儿!约战竞技场辅助器(外挂)竟然有辅助软件(哔哩哔哩)十分钟绝活儿!约战竞技场辅助器(外挂...
第九分钟烘培!凑一桌开挂游戏辅... 第九分钟烘培!凑一桌开挂游戏辅助(外挂)其实是有辅助软件(哔哩哔哩)该软件可以轻松地帮助玩家将凑一桌...
七分钟办法!新海贝之城脚本(外... 七分钟办法!新海贝之城脚本(外挂)总是是真的有辅助技巧(哔哩哔哩)1.新海贝之城脚本 选牌创建新账号...
4分钟指引!杭麻圈辅助工具(外... 4分钟指引!杭麻圈辅助工具(外挂)其实是真的有辅助方法(哔哩哔哩)1、全新机制【杭麻圈辅助工具ai辅...
第5分钟演示!浙江茶园辅助(外... 第5分钟演示!浙江茶园辅助(外挂)都是是真的有辅助app(哔哩哔哩)1、游戏颠覆性的策略玩法,独创攻...
三分钟举措!上饶中至能操控吗(... 三分钟举措!上饶中至能操控吗(外挂)好像一直都是有辅助软件(哔哩哔哩)1、让任何用户在无需上饶中至能...
两分钟法子!新天道能不能开挂(... 两分钟法子!新天道能不能开挂(外挂)总是是有辅助教程(哔哩哔哩)1、让任何用户在无需新天道能不能开挂...
三分钟要领!玖玖互娱辅助工具(... 三分钟要领!玖玖互娱辅助工具(外挂)真是存在有辅助脚本(哔哩哔哩)三分钟要领!玖玖互娱辅助工具(外挂...
8分钟手段!wepoker私人... 8分钟手段!wepoker私人局辅助器(外挂)确实有辅助技巧(哔哩哔哩)运wepoker私人局辅助器...
2分钟步骤!科乐游戏辅助脚本视... 2分钟步骤!科乐游戏辅助脚本视频(外挂)原来是真的有辅助插件(哔哩哔哩)1、任何科乐游戏辅助脚本视频...