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:
    

相关内容

热门资讯

黑科技数据(德扑之星软件可靠吗... 黑科技数据(德扑之星软件可靠吗)太实锤了果然真的是有挂(透视)切实教程(2020已更新)(哔哩哔哩)...
黑科技好友(红龙扑克辅助器安全... 黑科技好友(红龙扑克辅助器安全吗)太夸张了从前真的有挂(透视)攻略教程(2024已更新)(哔哩哔哩)...
黑科技插件(wepoke助力红... 黑科技插件(wepoke助力红包码)太实锤了都是是真的有挂(透视)教你攻略(2023已更新)(哔哩哔...
黑科技能赢(德之星辅助工具)太... 黑科技能赢(德之星辅助工具)太夸张了一向存在有挂(透视)新版2025教程(2021已更新)(哔哩哔哩...
黑科技ai代打(线上wpk德州... 黑科技ai代打(线上wpk德州ai打法)太坑了本然真的是有挂(透视)必胜教程(2026已更新)(哔哩...
黑科技数据(we-poker有... 黑科技数据(we-poker有挂吗)太无语了一向真的有挂(透视)解密教程(2021已更新)(哔哩哔哩...
黑科技安卓版(WePoKe辅助... 黑科技安卓版(WePoKe辅助多久会检测到)太离谱了先前真的是有挂(透视)总结教程(2024已更新)...
黑科技ai代打(德州AI辅助工... 黑科技ai代打(德州AI辅助工具)太离谱了素来存在有挂(透视)透明挂教程(2021已更新)(哔哩哔哩...
黑科技美元局(aapoker透... 1、黑科技美元局(aapoker透明辅助器)太无语了从前是真的有挂(透视)高科技教程(2025已更新...
黑科技安装(德扑之星app改数... 黑科技安装(德扑之星app改数据)太实锤了从前真的是有挂(透视)教你攻略(2020已更新)(哔哩哔哩...