Autodata: 使用autodoc-typehints记录没有函数签名的可调用对象
创始人
2024-09-22 21:04:31
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函数的函数签名和类型提示信息。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...