Autodata: 使用autodoc-typehints记录没有函数签名的可调用对象
创始人
2024-09-22 21:02:55
0

要使用autodoc-typehints记录没有函数签名的可调用对象,可以按照以下步骤进行操作:

  1. 安装Sphinx和sphinx-autodoc-typehints:

    pip install Sphinx sphinx-autodoc-typehints
    
  2. 在Sphinx项目的conf.py文件中添加以下配置:

    # conf.py
    
    extensions = [
        ...
        'sphinx.ext.autodoc',
        'sphinx_autodoc_typehints',
        ...
    ]
    
    # 设置autodoc-typehints的类型推断级别,默认为1(仅基于注释),可以设置为2(基于函数签名)
    autodoc_typehints = 'description'
    
    # 设置是否在文档中显示类型提示,默认为False
    autodoc_typehints_description_target = 'documented'
    
  3. 在需要记录可调用对象的模块中使用类型提示语法,例如函数参数的类型提示和返回值的类型提示:

    def add(a: int, b: int) -> int:
        """Adds two numbers."""
        return a + b
    
  4. 运行Sphinx生成文档:

    sphinx-build -b html  
    

    这将生成HTML格式的文档。

    如果你已经有一个Sphinx项目并且只想更新文档,可以使用以下命令:

    make html
    

    这将使用Makefile中的配置来生成文档。

在生成的文档中,你将看到可调用对象的函数签名以及类型提示信息。

这是一个完整的示例:

# mymodule.py

def add(a: int, b: int) -> int:
    """Adds two numbers."""
    return a + b
# conf.py

extensions = [
    ...
    'sphinx.ext.autodoc',
    'sphinx_autodoc_typehints',
    ...
]

autodoc_typehints = 'description'
autodoc_typehints_description_target = 'documented'

最后,运行Sphinx命令生成文档:

sphinx-build -b html . _build

在生成的HTML文档中,你将看到add函数的函数签名和类型提示信息。

相关内容

热门资讯

2026版教程!werplan... 您好,德普之星透视这款游戏可以开挂的,确实是有挂的,需要了解加去威信【136704302】很多玩家在...
2026版教学!wepoker... 2026版教学!wepoker私人局辅助器怎么用,德普之星怎么设置埋牌,本来是真的有挂(真的有挂)该...
攻略辅助挂!hh poker插... 攻略辅助挂!hh poker插件下载,德扑之星透视,切实真的有挂(有挂头条)一、德扑之星透视游戏安装...
刚刚!wepoker究竟有没有... 刚刚!wepoker究竟有没有透视,德普之星私人局透视,一直存在有挂(有挂实锤)1、德普之星私人局透...
2026版软件!wejoker... 2026版软件!wejoker免费脚本,德普之星怎么开辅助,都是是真的有挂(有人有挂)1、许多玩家不...
今年以来!we-poker辅助... 今年以来!we-poker辅助器,德扑之星透视软件免费入口官网,都是确实有挂(有挂教学)德扑之星透视...
为切实保障!wepoker破解... 为切实保障!wepoker破解器激活码,德普之星怎么开辅助,总是确实有挂(有挂教程)1、德普之星怎么...
据公告内容!pokemmo辅助... 据公告内容!pokemmo辅助工具,德普辅助器怎么用,都是是有挂(真的有挂)1、德普辅助器怎么用模拟...
据文件显示!大菠萝免费辅助,德... 据文件显示!大菠萝免费辅助,德普之星透视免费,竟然真的有挂(有挂头条)1、据文件显示!大菠萝免费辅助...
近日!wpk插件,德普之星私人... 近日!wpk插件,德普之星私人局透视,都是存在有挂(有挂秘籍)1、进入到德普之星私人局透视是否有挂之...