sphinx 中的自定义方法签名

Question

有没有一种简单的方法可以在sphinx中格式化方法签名？我正在使用 RTD 主题，并构建为 html。

我目前遇到的问题是：

• 使用输入模块创建的自定义类型注释正在以其完整形式打印，但我希望只打印它们的名称（例如CustomType = Union[type1, type2, type3]应该呈现为 simple CustomType，但会呈现为Union[type1, type2, type3]相反）

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

• 方法签名应该以某种方式突出显示语法，就像在 IDE 中一样

我不确定如何实现这些自定义，对我来说似乎 html 主题配置中没有任何选项可以这样做。

我尝试的第一件事是类似这段代码，但我有点卡住了。

一开始我也想过做一个 sphinx 的分支（就像这个用户尝试解决另一个恼人的问题[PR]），但后来我意识到，如果你不太了解这个项目，这样的事情真的很复杂出色地...

如有必要，我将提供更多详细信息。

Answer 1

这并不能完全满足我的需求，但至少从发布版本来看，2.1他们添加了从方法签名中排除类型提示的可能性。

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

autodoc_typehints = "none"

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

needs_sphinx = "2.1"