Python：docstrings和type annotations

Question

具有以下功能：

def foo(x: int) -> float:
    return float(x)

我想使用类似NumPy的文档字符串，如下所示：

def foo(x: int) -> float:
    """
    Parameters
    ----------
    x
        Input parameter

    Returns
    -------
    The output value.
    """
    return float(x)

请注意：

• 我不想再次指定参数类型。
• 我不想再次指定返回类型。
• 我希望该扩展能够读取带注释的类型（并在生成的HTML文档中写入它们）。

是否有支持该功能的Sphinx扩展？你会推荐另一种语法吗？

Answer 1

标准扩展名为autodoc。 Napoleon扩展程序支持Google和NumPy风格的文档字符串。