Python 使用autodoc排除方法签名

Python 使用autodoc排除方法签名,python,python-sphinx,autodoc,Python,Python Sphinx,Autodoc,我目前正在使用Sphinx httpdomain扩展记录一个HTTP API。我在每个请求端点上都有一个docstring,用于记录参数、查询参数、返回值和异常。我希望在Sphinx文档中使用此文档字符串 目前我使用的automethod指令如下: .. automethod:: Controller.method 这将使用httpdomain格式化docstring,包括正确的格式,但是,它也会像往常一样打印方法签名。结果看起来有点像: Controller.method() GET /en

我目前正在使用Sphinx httpdomain扩展记录一个HTTP API。我在每个请求端点上都有一个docstring,用于记录参数、查询参数、返回值和异常。我希望在Sphinx文档中使用此文档字符串

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

.. automethod:: Controller.method
这将使用httpdomain格式化docstring,包括正确的格式,但是,它也会像往常一样打印方法签名。结果看起来有点像:

Controller.method()
GET /endpoint_url
Docstring describing the resource.

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

您是说手动?然后我必须在两个不同的文件中维护文档,这正是我试图阻止的。维护py和rst文件不是问题,问题是维护重复的内容。此外,它不是一种方法,它涉及大约100种方法。