使用Cornice的Sphinx集成记录Cornice的资源

Question

我有Pyramid个Cornice个应用程序，其中我定义了Resources（而不是Services），我想知道是否可以生成Sphinx在Cornice's Sphinx integration的帮助下，该项目的文档？

我设法生成某种文档，但似乎大多数功能都不适用于资源，仅适用于服务，例如，以这种方式记录金字塔代码：

@resource(collection_path='/parse/', path='/parse/{id}', cors_origins=('*',), description="Temporary description.")
class Parser(object):

    @view(renderer='json')
    def collection_post(self):
        """
        Some description for this function...
        :param str smth: Some parameter
        :return: Returns something
        """
        return

并构建像这样的Sphinx文档：

.. cornice-autodoc::
   :modules: my_app.views.views_parser
   :ignore: parser

将导致文档中几乎没有必要和缺少的部分：

• 服务名称（实际上是资源名称）搞砸了，
• 函数collection_post本身未记录，
• 无需在collection_path声明中记录path和resource：

---

_{^{（生成文档中的示例摘录）}}

/ parse /

中的Collection_Parser服务

临时说明。

POST

回复：json

/ parse / {id}

的解析器服务

临时说明。

---

我想知道的是：

• 如何更改文档中生成的名称（Parser而不是Collection_Parser），
• 如何忽略＆＃39;一些带有:ignore:声明的模块（例如，我不想记录/parse/{id}部分），
• 如何在Resources中记录函数，因为只是忽略了注释块（在我的情况下是collection_post）

......还有很多其他的事情...... 这似乎是不可能的或根本没有记录。如果情况是这是不可能的，还有其他（至少是半自动的）解决方案来记录我的项目吗？

Answer 1

似乎这是不可能的，因为Cornice不支持这种功能（https://github.com/mozilla-services/cornice/issues/279）......