我目前正在尝试使用Sphinx(使用扩展程序sphinx-apidoc和napoleon)实现自动文档创建。这个方法非常有效,但如果能够自动添加参数列表中的类型提示(PEP484约定),那就更好了。
我想知道这是否可能。
更具体地说: (来自napoleon示例)
def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
"""Example function with PEP 484 type annotations.
Args:
param1: The first parameter.
param2: The second parameter.
Returns:
The return value. True for success, False otherwise.
"""
这将呈现如下:
参数列表包含所有参数,但不附加类型。可以手动添加它们,但这可能会在决定更改签名时引入未来的问题。
手动添加类型的示例:
def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
"""Example function with PEP 484 type annotations.
Args:
param1 (int): The first parameter.
param2 (str): The second parameter.
Returns:
The return value. True for success, False otherwise.
"""
该段代码将呈现为: