在 Sphinx 中将特定方法或函数参数标记为已弃用

Question

我正在使用 Sphinx 来记录 python 3 class，并且 class 中的某些方法具有不再使用的参数值。将这些标记为已弃用参数的最佳方法是什么？有在线文档提到将整个方法标记为已弃用，但我没有发现继续有效但参数已更改的方法。将这些参数标记为仅关键字可能对我的情况有所帮助。

补充：我声明的参数是这样的：

Some function description

:param bool param_a: If True, do something.
:param bool param_b: Deprecated since 0.2.4 - how should I mark this?
:return: An integer.
:rtype: int

Answer 1

使用deprecated directive.

.. deprecated:: 3.1
    Use ``arg`` instead.

Answer 2

Steve Piercy 发布的已弃用指令在 sphinx v4 中对我有用：

:param str myparam:
    Description of my param

    .. deprecated:: 1.1
        Use mynewparam instead

从info field lists文档中并没有特别清楚参数的描述可以是多行的，但是可以。