Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/306.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python sphinx中的自定义签名方法_Python_Python Sphinx - Fatal编程技术网

Python sphinx中的自定义签名方法

Python sphinx中的自定义签名方法,python,python-sphinx,Python,Python Sphinx,在sphinx中有一种格式化方法签名的简单方法? 我使用RTD主题,并构建html 我目前的问题是: 使用typing module创建的自定义类型批注正在以完整形式打印,但我只希望打印它们的名称(例如,CustomType=Union[type1,type2,type3]应简单地呈现为CustomType,但呈现为Union[type1,type2,type3]) 方法签名打印在一行上,我希望它打印成缩进的自定义表单 方法签名应该像在IDE中一样突出显示语法 我不知道如何实现这些定制,对我

在sphinx中有一种格式化方法签名的简单方法? 我使用RTD主题,并构建html

我目前的问题是:

  • 使用typing module创建的自定义类型批注正在以完整形式打印,但我只希望打印它们的名称(例如,
    CustomType=Union[type1,type2,type3]
    应简单地呈现为
    CustomType
    ,但呈现为
    Union[type1,type2,type3]

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

  • 方法签名应该像在IDE中一样突出显示语法

我不知道如何实现这些定制,对我来说,在html主题配置中似乎没有任何选项可以实现

我尝试的第一件事是,但我有点被绊倒了

在第一个时刻,我还想做一个sphinx叉子(就像这个用户试图解决另一个恼人的问题一样),但后来我意识到,如果你对这个项目不太了解,这样的事情真的很复杂


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

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

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

autodoc_typehints = "none"
我还建议设置此变量以指定最小的Sphinx版本:

needs_sphinx = "2.1"

@mzjn为什么要删除#sphinx标记?因为该标记不正确。您不是在问斯芬克斯搜索引擎()。好的,很好,谢谢:)关于第二个项目,请参阅