使用autodoc排除方法签名

时间:2013-12-11 11:16:26

标签: python python-sphinx

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

目前我使用了automethod指令,如:

.. automethod:: Controller.method

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

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

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

0 个答案:

没有答案