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函数的函数签名和类型提示信息。

相关内容

热门资讯

第8分钟带你科普!欢聚水鱼智能... 第8分钟带你科普!欢聚水鱼智能辅助,奇迹陕西辅助,揭秘教程(有挂细节)-哔哩哔哩;无需打开直接搜索加...
第一分钟带你科普!博乐填大坑图... 第一分钟带你科普!博乐填大坑图片,福州十八扑外卦,曝光教程(有挂规律)-哔哩哔哩;无需打开直接搜索加...
四分钟带你讲解!潮汕来物局开挂... 潮汕来物局开挂方法 无需打开直接搜索微信:136704302本司针对手游进行,选择我们的四大理由: ...
第三分钟带你透视!潮汕透视辅助... 第三分钟带你透视!潮汕透视辅助,决战卡五星开挂方法,必赢教程(有挂规律)-哔哩哔哩 【无需打开直接搜...
第8分钟带你开挂!天胡辅助脚本... 天蝎大厅辅助开挂教程视频分享装挂详细步骤在当今的网络游戏中,天蝎大厅辅助作为一种经典的娱乐方式,吸引...
第8分钟带你辅助!微信茶馆辅助... 第8分钟带你辅助!微信茶馆辅助器,全来潜山跑风破解版安卓,AI教程(揭秘有挂)-哔哩哔哩全来潜山跑风...
第五分钟带你发现!微信微乐游戏... 【亲,微信微乐游戏辅助脚本 这款游戏可以开挂的,确实是有挂的,很多玩家在这款微信微乐游戏辅助脚本中打...
5分钟带你辅助!wepoker... 5分钟带你辅助!wepoker插件程序,兴动互娱辅助器视频,大神讲解(新版有挂)-哔哩哔哩【无需打开...
第九分钟带你透视!新上游辅助,... 第九分钟带你透视!新上游辅助,悠闲卡五星辅助,攻略教程!(存在有挂)-哔哩哔哩1、下载安装好悠闲卡五...
十分钟带你透视!湖湘互娱牛牛,... 十分钟带你透视!湖湘互娱牛牛,胡乐辅助脚本,实用技巧(证实有挂)-哔哩哔哩>>您好:软件加薇1367...