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:
    

相关内容

热门资讯

黑科技透视器!山西扣点点(透视... 黑科技透视器!山西扣点点(透视器),新067互娱真是有透视挂教程(有辅助挂详情)该软件可以轻松地帮助...
黑科技外挂!完美体育(外挂),... 黑科技外挂!完美体育(外挂),新青岛其实有透视挂方法(有辅助挂方针)1、完美体育透视辅助软件激活码多...
黑科技开挂!玩牌(开挂),财神... 黑科技开挂!玩牌(开挂),财神十三张其实是有透视挂攻略(确实有辅助挂)1、下载好财神十三张透视辅助下...
黑科技作弊器!嗨玩干瞪眼(作弊... 黑科技作弊器!嗨玩干瞪眼(作弊器),乐乐四川麻将竟然存在有透视挂脚本(有辅助挂工具)亲,关键说明,乐...
黑科技辅助!同城跑胡子合集(辅... 黑科技辅助!同城跑胡子合集(辅助),南通长牌总是有透视挂技巧(有辅助挂神器)同城跑胡子合集是不是有人...
黑科技外挂!丰城双剑(外挂),... 黑科技外挂!丰城双剑(外挂),悠游其实存在有透视挂技巧(有辅助挂辅教程)暗藏猫腻,小编详细说明丰城双...
黑科技透视挂!全民比鸡(透视挂... 黑科技透视挂!全民比鸡(透视挂),兴动游戏原来是有透视挂攻略(有辅助挂猫腻)1、每一步都需要思考,不...
黑科技作弊器!南京麻将(作弊器... 黑科技作弊器!南京麻将(作弊器),安安休闲一直存在有透视挂工具(有辅助挂辅教程)1、完成安安休闲有辅...
黑科技作弊器!仲乐麻将(作弊器... 黑科技作弊器!仲乐麻将(作弊器),天天飞小鸡三拿一切实存在有透视挂软件(有辅助挂详情)1、任何天天飞...
黑科技开挂!亲朋千分(开挂),... 黑科技开挂!亲朋千分(开挂),良人麻将原来有透视挂攻略(有辅助挂秘诀)1、下载好亲朋千分透视辅助下载...