我目前正在使用 Sphinxhttpdomain
扩展记录 HTTP API。我在每个请求端点上都有一个文档字符串,用于记录参数、查询参数、返回值和异常。我希望在 Sphinx 文档中使用这个文档字符串。
目前我使用了 automethod 指令,如:
.. automethod:: Controller.method
这将格式化文档字符串,包括使用httpdomain
.
Controller.method()
GET /endpoint_url
Docstring describing the resource.
我基本上希望它跳过第一行。我在 SO 上发现了另一个与此类似的问题,它提供了抑制所有方法签名的解决方案。但是,此文档是一个更大项目的一部分,我希望autodoc
为所有其他自动生成的文档保留功能。