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

Question

有没有办法在Sphinx中标记一个类或方法为“过时”？我只找到模块的过时选项。

使用通用的提示信息是可以的，但这样做没有特别的含义。

Answer 1

另一种选择是使用 deprecation 这个模块。

它提供了一种装饰器，可以标记你的类或函数为“过时”。这样，当有人使用这个类或函数时，就会出现一个过时的警告，同时在sphinx文档中也会生成相应的说明段落。

Answer 2

我觉得你在找的是 deprecated 这个东西。