sphinx-autodoc-napoleon-typehints 2.1.6

Sphinx Autodoc Napoleon类型提示

此扩展允许您使用Python3注释来记录可接受的参数类型 函数的返回值类型。这允许您以非常自然的方式使用类型提示， 允许您从此处迁移：

defformat_unit(value,unit):"""
    Formats the given value as a human readable string using the given units.

    :param float|int value: a numeric value
    :param str unit: the unit for the value (kg, m, etc.)
    :rtype: str
    """return'{} {}'.format(value,unit)

对此：

fromtypingimportUniondefformat_unit(value:Union[float,int],unit:str)->str:"""
    Formats the given value as a human readable string using the given units.

    :param value: a numeric value
    :param unit: the unit for the value (kg, m, etc.)
    """return'{} {}'.format(value,unit)

在拿破仑的帮助下，也支持google docstrings或numpydocstrings。 napoleon sphinx extention。 这意味着即使是这样的docstring：

defformat_unit_google(self,value:Union[float,int],unit:str,test:Optional[Union[Iterable,str]])->str:"""
    Formats the given value as a human readable string using the given units.

    Args:
        value: a numeric value
        unit: the unit for the value (kg, m, etc.)
        test: bla bla blathe unit for the value (kg, m, etc.)

    Returns:
       This function returns something of
       value: and does not overwrite this part.
    """return'{} {}'.format(value,unit)defformat_unit_numpy(self,value:Union[float,int],unit:str,test:Optional[Union[Iterable,str]])->str:"""
    Formats the given value as a human readable string using the given units.

    Parameters
    ----------
    value: a numeric value
    unit: the unit for the value (kg, m, etc.)
    test: bla bla blathe unit for the value (kg, m, etc.)

    Returns
    -------
    This function returns something of
    value: and does not overwrite this part.
    """return'{} {}'.format(value,unit)

其结果与以上相同

$ pip install sphinx-autodoc-napoleon-typehints

extensions=['sphinx.ext.autodoc','sphinx_autodoc_napoleon_typehints']