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風格的文檔字符串。