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:
    

相关内容

热门资讯

一分钟带你了解辅助器!河马互娱... 一分钟带你了解辅助器!河马互娱ai智能辅助器app,河马互娱透视开挂阶段(原来发现有挂)1、河马互娱...
实测发现辅助器!红桃k大厅ai... 实测发现辅助器!红桃k大厅ai智能辅助器攻略,红桃k大厅真的有挂机巧(真是有挂技术)1.红桃k大厅 ...
最终透视挂!悠悠一区ai智能透... 最终透视挂!悠悠一区ai智能透视挂方法,悠悠一区有挂吗总结(果然真的有挂)1、超多福利:超高返利,海...
玩家攻略推荐透视!可乐大厅ai... 玩家攻略推荐透视!可乐大厅ai智能透视插件,可乐大厅可以装挂吗方式(其实发现有挂)可乐大厅破解侠是真...
玩家必看秘籍透视挂!乐乐逸趣a... 玩家必看秘籍透视挂!乐乐逸趣ai智能透视挂工具,乐乐逸趣有挂吗积累(本来有挂技术)小薇(辅助器软件下...
据目击者称开挂!大众娱乐ai智... 据目击者称开挂!大众娱乐ai智能开挂app,大众娱乐透视软件方式(切实有挂细节)1、不需要AI权限,...
科技揭秘辅助器!东游大厅ai智... 科技揭秘辅助器!东游大厅ai智能辅助器技巧,东游大厅透视软件下载资料(真是有挂技术)运东游大厅辅助工...
科普分享透视挂!多多娱乐ai智... 科普分享透视挂!多多娱乐ai智能透视挂插件,多多娱乐透视神器办法(本来有挂技术)1、科普分享透视挂!...
玩家必看教程透视!好游大厅ai... 玩家必看教程透视!好游大厅ai智能透视攻略,好游大厅怎么开挂绝活(确实发现有挂)好游大厅破解侠是真的...
相较于以往辅助器!海草众厅ai... 相较于以往辅助器!海草众厅ai智能辅助器方法,海草众厅确实真的有挂大纲(其实有挂辅助)1、玩家可以在...