使用autod排除方法签名

2024-06-26 13:15:54 发布

您现在位置:Python中文网/ 问答频道 /正文

我目前正在使用sphinxhttpdomain扩展编写httpapi文档。我在每个请求端点上都有一个docstring,用于记录参数、查询参数、返回值和异常。我希望这个docstring可以用在Sphinx文档中。在

目前我使用的automethod指令如下:

.. automethod:: Controller.method

这将使用httpdomain格式化docstring,包括正确的格式,但是,它也会打印方法签名(一如既往)。结果看起来有点像:

^{pr2}$

基本上我想跳过第一行。我发现了另一个与此类似的问题,它提供了一个抑制所有方法签名的解决方案。但是,这个文档是一个更大项目的一部分,我希望保留autodoc的功能,就像其他所有自动生成的文档一样。在


Tags: 方法文档参数sphinx记录指令端点method