Python: gibi bir işlevi olması Docstringler ve yazın ek açıklamaları

Question

:

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

Ben aşağıdaki gibi bir NumPy benzeri docstring'ini kullanmak istiyorum:

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

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

Not olun:

• Parametre türünü tekrar belirtmek istemiyorum.
• Dönüş türünü tekrar belirtmek istemiyorum.
• Bu uzantının açıklamalı yazı tiplerini okuyabilmesini (ve oluşturulan HTML belgelerinde yazmasını) istiyorum.

Bunu destekleyen bir Sphinx uzantısı var mı? Başka bir sözdizimi tavsiye eder misiniz?

Answer 1

Standart uzantı autodoc'dur. Napoleon uzantısı Google ve NumPy tarzı doküman şeritlerini destekler.