在sphinx中定制签名方法

Question

在sphinx中有一种格式化方法签名的简单方法吗？ 我正在使用RTD主题，并构建html。你知道吗

我目前的问题是：

• 使用typing模块创建的自定义类型注释将以其完整形式打印，但我只希望打印它们的名称（例如CustomType = Union[type1, type2, type3]应该被呈现为简单的CustomType，而被呈现为Union[type1, type2, type3]）

• 方法签名打印在一行上，我希望它打印为缩进自定义表单

• 方法签名应该以某种方式突出显示IDE中的语法

我不知道如何实现这些定制，对我来说，似乎没有任何选项在html主题配置这样做。你知道吗

我第一次尝试的是类似于this code的东西，但我有点被绊倒了。你知道吗

刚开始我还想做一个sphinx的fork（就像这个用户试图解决另一个恼人的问题[PR]），但后来我意识到，如果你不太了解这个项目的话，这样的事情真的很复杂。。。你知道吗

如有必要，我将提供进一步的细节。你知道吗

Answer 1

这并不能完全满足我的要求，但至少在发行版2.1中，他们增加了从方法签名中排除类型提示的可能性。你知道吗

您可以通过在docsconf.py文件中设置以下行来启用此功能：

autodoc_typehints = "none"

我还建议将此变量设置为指定最小的Sphinx版本：

needs_sphinx = "2.1"