logo标签列表

在Sphinx中将类和/或方法标记为弃用

pythonpython-sphinxdeprecated
28

有没有办法在Sphinx中将一个类和/或方法标记为弃用？我只能找到模块的弃用选项。

使用通用警告可能有效，但无法传达语义含义。

2个回答
28
1
使用Napoleon.ext和Google风格时，这个不起作用。 - G M
0
另一种可能性是使用deprecation模块。
它提供了一个装饰器，用于标记您的类/函数已过时。这不仅会在使用类/函数时产生一个过时警告，还会在sphinx中生成正确的段落。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接