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

Parameters 在Sphinx中将特定方法或函数参数标记为已弃用,parameters,python-sphinx,deprecated,Parameters,Python Sphinx,Deprecated,我使用Sphinx来记录一个Python3类,该类中的一些方法具有不再使用的参数值。将这些参数标记为不推荐的参数的最佳方法是什么?有在线文档提到将整个方法标记为已弃用,但我没有发现继续处于活动状态但其参数已更改的方法。在我的情况下,将这些参数标记为仅关键字可能会有所帮助 添加:我声明如下参数: Some function description :param bool param_a: If True, do something. :param bool param_b: Deprecated

我使用Sphinx来记录一个Python3类,该类中的一些方法具有不再使用的参数值。将这些参数标记为不推荐的参数的最佳方法是什么?有在线文档提到将整个方法标记为已弃用,但我没有发现继续处于活动状态但其参数已更改的方法。在我的情况下,将这些参数标记为仅关键字可能会有所帮助

添加:我声明如下参数:

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
使用


这里的示例似乎暗示它可能用于整个函数或方法。是否有一种方法(或示例)可以记录已弃用的参数,但也可以将其标记为已弃用?这取决于您是否记录了参数。如果你这样做了,那么把指令放在你记录它们的地方。我在问题中添加了说明我是如何记录参数的。我不知道如何压缩
。。不推荐使用::
指令在那里?这将不起作用,因为该上下文中只支持文本,不支持解析。我的意思是更像这个和它的源docstring(滚动到结尾)。你试过什么?请编辑您的答案。如果a中的参数描述包含块语法,我不认为它可以解析为StructuredText,但是您可以尝试,确保使用正确的缩进。它可能能够解析内联语法,例如
:term:
.. deprecated:: 3.1
    Use ``arg`` instead.